ImageFromFile Class Reference

A class to help use an image asset loaded from the file system as Image.sprite for the current skin in multiple languages. More...

Inheritance diagram for ImageFromFile:

Public Member Functions
override void	Load (string language)
Public Member Functions inherited from AssetFromFile
bool	IsAssetAvailable (string language)
	Looks up the asset from FAST.Application.assets dictionary using language and FAST.AssetFromFile.fileName to see if the file exists.
void	Load (string language)
	Loads the asset from FAST.Application.assets dictionary using language and FAST.AssetFromFile.fileName.

Protected Member Functions
override void	Awake ()
override void	SetNameWithFileExtension ()
	When you right-click on FAST.AssetFromFile.baseFileName in the Inspector, this function will run in the Editor to get the filename of the Image.sprite assigned to FAST.ImageFromFile.uiImage.
Protected Member Functions inherited from AssetFromFile
void	LogAssetNotLoadedError ()
	Call this to log an error when an FAST.AssetFromFile cannot be loaded.
void	SetNameWithFileExtension ()
	When you right-click on FAST.AssetFromFile.baseFileName in the Inspector, this function will run in the Editor to get the filename of an asset assigned to a corresponding Component.
void	UpdateFileName (string language)
	Updates FAST.AssetFromFile.fileName using language, FAST.AssetSettings, FAST.AssetFromFile.prefixFileName, FAST.AssetFromFile.baseFileName, and FAST.AssetFromFile.suffixFileName.

Private Member Functions
void	SetImageSettings ()
	When you right-click on FAST.ImageFromFile.imageSettings in the Inspector, this function will run in the Editor to get the TextureImporterSettings of the Sprite assigned to FAST.ImageFromFile.uiImage.

Private Attributes
ImageSettings	imageSettings = new()
	Inspector The image import settings to use when loading the image asset as a Sprite.
Image	uiImage
	Inspector, Runtime The Image component that the image asset is loaded into.

Additional Inherited Members
Public Attributes inherited from AssetFromFile
string	baseFileName
	Inspector, Code The name of the asset with the file extension, but without the prefix or suffix.
Static Public Attributes inherited from AssetFromFile
const string	kSharedLanguage = "Shared"
	Use this string as the language name for assets that are the same across all languages and can be shared.
Protected Attributes inherited from AssetFromFile
string	fileName
	Runtime The full file name combined from the FAST.AssetFromFile.prefixFileName, FAST.AssetFromFile.baseFileName, and FAST.AssetFromFile.suffixFileName at runtime.
bool	isSharedByAllLanguages
	Inspector Set to true if this asset is the same across all languages and can be shared.
string	prefixFileName
	Settings A string loaded from FAST.AssetSettings that will be added to the front of the FAST.AssetFromFile.baseFileName at runtime.
string	suffixFileName
	Settings A string loaded from FAST.AssetSettings that will be inserted to the end of the FAST.AssetFromFile.baseFileName, but before the extension, at runtime.
Static Protected Attributes inherited from AssetFromFile
const string	kLanguageTag = "#Language"
	Use this string in the FAST.AssetSettings.prefixFileName or FAST.AssetSettings.suffixFileName to be replaced with the FAST.Application.language at runtime.
const string	kProductNameTag = "#ProductName"
	Use this string in the FAST.AssetSettings.prefixFileName or FAST.AssetSettings.suffixFileName to be replaced with the UnityEngine.Application.productName at runtime.
const string	kSkinTag = "#Skin"
	Use this string in the FAST.AssetSettings.prefixFileName or FAST.AssetSettings.suffixFileName to be replaced with the FAST.AssetSettings.skin at runtime.

Detailed Description

A class to help use an image asset loaded from the file system as Image.sprite for the current skin in multiple languages.

Assets are stored in FAST.Application.assets dictionary. This class will load the asset by looking it up in the dictionary using language in FAST.AssetFromFile.Load(string) and FAST.AssetFromFile.fileName.

See also

UnityEngine.Application

UnityEngine.Sprite

UnityEngine.UI.Image

UnityEditor.TextureImporterSettings

Member Function Documentation

Awake()

override void Awake ( )

protectedvirtual

When the script is loaded, FAST.AssetFromFile.UpdateFileName(string) is called to initialize FAST.AssetFromFile.fileName.

Retrieves the Image component at runtime if FAST.ImageFromFile.uiImage isn't assigned in the Inspector at runtime.

Reimplemented from AssetFromFile.

Load()

override void Load

(

string

language

)

Loads the asset from FAST.Application.assets dictionary using language and FAST.AssetFromFile.fileName.

Parameters

language

The language of the asset to load.

FAST.ImageFromFile.imageSettings are used to load the image asset as a Sprite into FAST.ImageFromFile.uiImage.

SetImageSettings()

void SetImageSettings ( )

private

When you right-click on FAST.ImageFromFile.imageSettings in the Inspector, this function will run in the Editor to get the TextureImporterSettings of the Sprite assigned to FAST.ImageFromFile.uiImage.

SetNameWithFileExtension()

override void SetNameWithFileExtension ( )

protected

When you right-click on FAST.AssetFromFile.baseFileName in the Inspector, this function will run in the Editor to get the filename of the Image.sprite assigned to FAST.ImageFromFile.uiImage.

Member Data Documentation

imageSettings

ImageSettings imageSettings = new()

private

Inspector
The image import settings to use when loading the image asset as a Sprite.

uiImage

Image uiImage

private

Inspector, Runtime
The Image component that the image asset is loaded into.

Retrieved at runtime from FAST.ImageFromFile.Awake if no Image is assigned in the Inspector.

---

The documentation for this class was generated from the following file:

• C:/Users/cgbrown/Development/git/FAST/FAST-SDK/Runtime/Assets From File/ImageFromFile.cs