#include <ImageAsset.h>

Inheritance diagram for ImageAsset:

Classes
class	FrameArea
	Frame area. More...
class	ImageLayer

Public Types
enum	TextureFilterMode { FILTER_NEAREST , FILTER_BILINEAR , FILTER_INVALID }
	Texture Filter Mode. More...
Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }
enum	CopyFieldsFlags { CopyFields_SkipName = BIT(0) , CopyFields_SkipParentGroup = BIT(1) , CopyFields_SkipScriptClass = BIT(2) }
	What copyFieldsFrom may be told to leave alone. More...

Public Member Functions
	ImageAsset ()
virtual	~ImageAsset ()
virtual bool	onAdd ()
	Called when the object is added to the sim.
virtual void	onRemove ()
	Called when the object is removed from the sim.
virtual void	copyAssetStateTo (AssetBase *pTarget)
void	setImageFile (const char *pImageFile)
StringTableEntry	getImageFile (void) const
StringTableEntry	getRelativeImageFile (void) const
void	setForce16Bit (const bool force16Bit)
bool	getForce16Bit (void) const
void	setFilterMode (const TextureFilterMode filterMode)
TextureFilterMode	getFilterMode (void) const
void	setExplicitMode (const bool explicitMode)
bool	getExplicitMode (void) const
void	setCellRowOrder (const bool cellRowOrder)
bool	getCellRowOrder (void) const
void	setCellOffsetX (const S32 cellOffsetX)
S32	getCellOffsetX (void) const
void	setCellOffsetY (const S32 cellOffsetY)
S32	getCellOffsetY (void) const
void	setCellStrideX (const S32 cellStrideX)
S32	getCellStrideX (void) const
void	setCellStrideY (const S32 cellStrideY)
S32	getCellStrideY (void) const
void	setCellCountX (const S32 cellCountX)
S32	getCellCountX (void) const
void	setCellCountY (const S32 cellCountY)
S32	getCellCountY (void) const
void	setCellWidth (const S32 cellWidth)
S32	getCellWidth (void) const
void	setCellHeight (const S32 cellheight)
S32	getCellHeight (void) const
Vector2	getExplicitCellOffset (const S32 cellIndex)
S32	getExplicitCellWidth (const S32 cellIndex)
S32	getExplicitCellHeight (const S32 cellIndex)
StringTableEntry	getExplicitCellName (const S32 cellIndex)
S32	getExplicitCellIndex (const char *regionName)
bool	containsNamedRegion (const char *regionName)
TextureHandle &	getImageTexture (void)
S32	getImageWidth (void) const
S32	getImageHeight (void) const
U32	getFrameCount (void) const
bool	containsFrame (const char *namedFrame)
FrameArea &	getCellByName (const char *cellName)
const FrameArea &	getImageFrameArea (U32 frame) const
const FrameArea &	getImageFrameArea (const char *namedFrame)
const void	bindImageTexture (void)
virtual bool	isAssetValid (void) const
bool	clearExplicitCells (void)
	Explicit cell control.
bool	addExplicitCell (const S32 cellOffsetX, const S32 cellOffsetY, const S32 cellWidth, const S32 cellHeight, const char *regionName)
bool	insertExplicitCell (const S32 cellIndex, const S32 cellOffsetX, const S32 cellOffsetY, const S32 cellWidth, const S32 cellHeight, const char *regionName)
bool	removeExplicitCell (const S32 cellIndex)
bool	removeExplicitCell (const char *regionName)
bool	setExplicitCell (const S32 cellIndex, const S32 cellOffsetX, const S32 cellOffsetY, const S32 cellWidth, const S32 cellHeight, const char *regionName)
S32	getExplicitCellCount (void) const
void	forceCalculation (void)
void	addLayer (const char *imagePath, const Point2I position, const ColorF blendColor, const bool doRedraw=true)
	Layers.
void	insertLayer (const U32 index, const char *imagePath, const Point2I position, const ColorF blendColor, const bool doRedraw=true)
void	removeLayer (const U32 index, const bool doRedraw=true)
void	moveLayerForward (const U32 index, const bool doRedraw=true)
void	moveLayerBackward (const U32 index, const bool doRedraw=true)
void	moveLayerToFront (const U32 index, const bool doRedraw=true)
void	moveLayerToBack (const U32 index, const bool doRedraw=true)
void	setLayerImage (const U32 index, const char *imagePath, const bool doRedraw=true)
void	setLayerPosition (const U32 index, const Point2I position, const bool doRedraw=true)
void	setLayerBlendColor (const U32 index, const ColorF color, const bool doRedraw=true)
const U32	getLayerCount ()
const char *	getLayerImage (const U32 index)
const Point2I	getLayerPosition (const U32 index)
const ColorF	getLayerBlendColor (const U32 index)
void	forceRedrawImage ()
void	setBlendColor (const ColorF color, const bool doRedraw=true)
const ColorF	getBlendColor ()
	DECLARE_CONOBJECT (ImageAsset)
	Declare Console Object.
Public Member Functions inherited from AssetBase
	AssetBase ()
virtual	~AssetBase ()
virtual void	copyTo (SimObject *object)
void	setAssetName (const char *pAssetName)
	Asset configuration.
StringTableEntry	getAssetName (void) const
void	setAssetDescription (const char *pAssetDescription)
StringTableEntry	getAssetDescription (void) const
void	setAssetCategory (const char *pAssetCategory)
StringTableEntry	getAssetCategory (void) const
void	setAssetAutoUnload (const bool autoUnload)
bool	getAssetAutoUnload (void) const
void	setAssetInternal (const bool assetInternal)
bool	getAssetInternal (void) const
bool	getAssetPrivate (void) const
StringTableEntry	getAssetType (void) const
S32	getAcquiredReferenceCount (void) const
bool	getOwned (void) const
StringTableEntry	getAssetId (void) const
StringTableEntry	expandAssetFilePath (const char *pAssetFilePath) const
	Expanding/Collapsing asset paths is only available once registered with the asset manager.
StringTableEntry	collapseAssetFilePath (const char *pAssetFilePath) const
bool	getAssetDirty (void) const
	Whether the asset has changes that have not been saved.
void	refreshAsset (void)
bool	saveAsset (void)
	Save the asset's file, and revert it to what that file already holds.
bool	revertAsset (void)
AssetBase *	createStateSnapshot (void)
bool	restoreStateSnapshot (AssetBase *pSnapshot)
	DECLARE_CONOBJECT (AssetBase)
	Declare Console Object.
Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const
StringTableEntry	getSuperClassNamespace () const
void	setClassNamespace (const char *classNamespace)
void	setSuperClassNamespace (const char *superClassNamespace)
void	pushScriptCallbackGuard (void)
void	popScriptCallbackGuard (void)
S32	getScriptCallbackGuard (void)
virtual SimObject *	findObject (const char *name)
Namespace *	getNamespace ()
	Return the object's namespace.
const char *	tabComplete (const char *prevText, S32 baseLen, bool)
virtual void	dump ()
virtual void	dumpClassHierarchy ()
SimObject *	clone (const bool copyDynamicFields)
SimObject *	deepClone ()
template<typename T>
bool	isType (void)
virtual bool	handlesConsoleMethod (const char fname, S32 routingId)
	DECLARE_CONOBJECT (SimObject)
virtual bool	writeField (StringTableEntry fieldname, const char *value)
virtual void	write (Stream &stream, U32 tabStop, U32 flags=0)
virtual void	writeFields (Stream &stream, U32 tabStop)
virtual bool	writeObject (Stream *stream)
virtual bool	readObject (Stream *stream)
virtual void	buildFilterList ()
void	addFieldFilter (const char *fieldName)
void	removeFieldFilter (const char *fieldName)
void	clearFieldFilters ()
bool	isFiltered (const char *fieldName)
void	assignFieldsFrom (SimObject *obj)
void	copyFieldsFrom (SimObject *obj, const U32 flags)
void	assignDynamicFieldsFrom (SimObject *obj)
Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list.
void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted.
void	clearNotify (SimObject *obj)
	Notify an object when we are cleared.
void	clearAllNotifications ()
	Remove all notifications for this object.
void	processDeleteNotifies ()
	Send out deletion notifications.
void	registerReference (SimObject **obj)
void	unregisterReference (SimObject **obj)
void	addListener (std::string objID)
void	removeListener (std::string objID)
void	removeAllListeners ()
void	postEvent (std::string eventName, std::string data)
const char *	getDataField (StringTableEntry slotName, const char *array)
virtual void	setDataField (StringTableEntry slotName, const char array, const char value)
const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)
void	setPrefixedDataField (StringTableEntry fieldName, const char array, const char value)
const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)
void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char array, const char value, const S32 fieldType=-1)
StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)
U32	getDataFieldType (StringTableEntry slotName, const char *array)
SimFieldDictionary *	getFieldDictionary ()
void	clearDynamicFields (void)
	Clear all dynamic fields.
void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true.
bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true.
void	setInternalName (const char *newname)
StringTableEntry	getInternalName ()
	Get the internal of of this control.
virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File.
virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace.
SimObjectId	getId (void) const
StringTableEntry	getIdString (void) const
U32	getType () const
const StringTableEntry	getName (void) const
void	setId (SimObjectId id)
void	assignName (const char *name)
SimGroup *	getGroup () const
bool	isChildOfGroup (SimGroup *pGroup)
bool	isProperlyAdded () const
bool	isDeleted () const
bool	isRemoved () const
bool	isLocked () const
void	setLocked (bool b)
bool	isHidden () const
void	setHidden (bool b)
void	setProgenitorFile (const char *pFile)
StringTableEntry	getProgenitorFile (void) const
void	setPeriodicTimerID (const S32 timerID)
S32	getPeriodicTimerID (void) const
bool	isPeriodicTimerActive (void) const
bool	isSelected () const
bool	isExpanded () const
void	setSelected (bool sel)
void	setExpanded (bool exp)
void	setModDynamicFields (bool dyn)
void	setModStaticFields (bool sta)
	SimObject ()
virtual	~SimObject ()
virtual bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)).
virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup.
virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup.
virtual void	onNameChange (const char *name)
	Called when the object's name is changed.
virtual void	onStaticModified (const char slotName, const char newValue=NULL)
virtual void	inspectPreApply ()
virtual void	inspectPostApply ()
virtual void	onDeleteNotify (SimObject *object)
virtual void	onEditorEnable ()
	Called when the editor is activated.
virtual void	onEditorDisable ()
	Called when the editor is deactivated.
bool	registerObject ()
bool	registerObject (U32 id)
bool	registerObject (const char *name)
bool	registerObject (const char *name, U32 id)
void	unregisterObject ()
void	deleteObject ()
bool	addToSet (SimObjectId)
bool	addToSet (const char *)
bool	removeFromSet (SimObjectId)
bool	removeFromSet (const char *)
Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name.
virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep.
bool	setField (const char fieldName, const char value)
	Set the value of a field.
virtual	~ConsoleObject ()
const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified.
AbstractClassRep::FieldList &	getModifiableFieldList ()
bool &	getDynamicGroupExpand ()
S32	getClassId (U32 netClassGroup) const
const char *	getClassName () const

Static Public Member Functions
static void	initPersistFields ()
	Core.
static StringTableEntry	nextAvailableCellName (const Vector< StringTableEntry > &used, const S32 seedIndex)
static TextureFilterMode	getFilterModeEnum (const char *label)
static const char *	getFilterModeDescription (TextureFilterMode filterMode)
Static Public Member Functions inherited from AssetBase
static void	initPersistFields ()
	Engine.
Static Public Member Functions inherited from SimObject
static void	initPersistFields ()
Static Public Member Functions inherited from ConsoleObject
static const char *	lookupClassName (const U32 in_classTag)
	Get the classname from a class tag.
static void	initPersistFields ()
static void	consoleInit ()
static AbstractClassRep *	getStaticClassRep ()
	Get the abstract class information for this class.
static AbstractClassRep *	getParentStaticClassRep ()
	Get the abstract class information for this class's superclass.
static ConsoleObject *	create (const char *in_pClassName)
static ConsoleObject *	create (const U32 groupId, const U32 typeId, const U32 in_classId)

Protected Member Functions
virtual void	initializeAsset (void)
virtual void	onAssetRefresh (void)
virtual void	onTamlPreWrite (void)
	Taml callbacks.
virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object.
virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Called during the writing of the object to allow custom properties to be written.
virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read.
virtual void	loadTamlExplicitCells (const TamlCustomNodes &customNodes)
virtual void	loadTamlImageLayers (const TamlCustomNodes &customNodes)
Protected Member Functions inherited from SimObject
virtual void	onTamlPreRead (void)
	Called prior to Taml reading the object.
virtual void	onTamlPostRead (const TamlCustomNodes &customNodes)
virtual void	onTamlAddParent (SimObject *pParentObject)
	Called after Taml has finished reading the object and has added the object to any parent.
void	linkNamespaces ()
void	unlinkNamespaces ()
virtual SimObject *	allocClone ()
	A registered but empty object of this object's class.
void	cloneInto (SimObject *clone)
virtual void	deepCloneChildren (SimObject *clone)
Protected Member Functions inherited from ConsoleObject
	ConsoleObject ()
	ConsoleObject (const ConsoleObject &)

Static Protected Member Functions
static void	textureEventCallback (const U32 eventCode, void *userData)
static bool	setImageFile (void obj, const char data)
static const char *	getImageFile (void obj, const char data)
static bool	writeImageFile (void *obj, StringTableEntry pFieldName)
static bool	setForce16Bit (void obj, const char data)
static bool	writeForce16Bit (void *obj, StringTableEntry pFieldName)
static bool	setFilterMode (void obj, const char data)
static bool	writeFilterMode (void *obj, StringTableEntry pFieldName)
static bool	setExplicitMode (void obj, const char data)
static bool	writeExplicitMode (void *obj, StringTableEntry pFieldName)
static bool	setCellRowOrder (void obj, const char data)
static bool	writeCellRowOrder (void *obj, StringTableEntry pFieldName)
static bool	setCellOffsetX (void obj, const char data)
static bool	writeCellOffsetX (void *obj, StringTableEntry pFieldName)
static bool	setCellOffsetY (void obj, const char data)
static bool	writeCellOffsetY (void *obj, StringTableEntry pFieldName)
static bool	setCellStrideX (void obj, const char data)
static bool	writeCellStrideX (void *obj, StringTableEntry pFieldName)
static bool	setCellStrideY (void obj, const char data)
static bool	writeCellStrideY (void *obj, StringTableEntry pFieldName)
static bool	setCellCountX (void obj, const char data)
static bool	writeCellCountX (void *obj, StringTableEntry pFieldName)
static bool	setCellCountY (void obj, const char data)
static bool	writeCellCountY (void *obj, StringTableEntry pFieldName)
static bool	setCellWidth (void obj, const char data)
static bool	writeCellWidth (void *obj, StringTableEntry pFieldName)
static bool	setCellHeight (void obj, const char data)
static bool	writeCellHeight (void *obj, StringTableEntry pFieldName)
static bool	setBlendColor (void obj, const char data)
static bool	writeBlendColor (void *obj, StringTableEntry pFieldName)
Static Protected Member Functions inherited from AssetBase
static bool	setAssetName (void obj, const char data)
static const char *	getAssetName (void obj, const char data)
static bool	writeAssetName (void *obj, StringTableEntry pFieldName)
static bool	setAssetDescription (void obj, const char data)
static const char *	getAssetDescription (void obj, const char data)
static bool	writeAssetDescription (void *obj, StringTableEntry pFieldName)
static bool	setAssetCategory (void obj, const char data)
static const char *	getAssetCategory (void obj, const char data)
static bool	writeAssetCategory (void *obj, StringTableEntry pFieldName)
static bool	setAssetAutoUnload (void obj, const char data)
static const char *	getAssetAutoUnload (void obj, const char data)
static bool	writeAssetAutoUnload (void *obj, StringTableEntry pFieldName)
static bool	setAssetInternal (void obj, const char data)
static const char *	getAssetInternal (void obj, const char data)
static bool	writeAssetInternal (void *obj, StringTableEntry pFieldName)
static const char *	getAssetPrivate (void obj, const char data)
Static Protected Member Functions inherited from SimObject
static bool	setClass (void obj, const char data)
static bool	setSuperClass (void obj, const char data)
static bool	writeObjectName (void *obj, StringTableEntry pFieldName)
static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)
static bool	writeInternalName (void *obj, StringTableEntry pFieldName)
static bool	setParentGroup (void obj, const char data)
static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)
static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)
static bool	writeClass (void *obj, StringTableEntry pFieldName)
static bool	setProtectedName (void obj, const char data)
static const char *	getProtectedName (void obj, const char data)
static SimObject::Notify *	allocNotify ()
	Get a free Notify structure.
static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free.
static void	addGroup (const char in_pGroupname, const char in_pGroupDocs=NULL)
static void	endGroup (const char *in_pGroupname)
static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char in_pFieldDocs)
static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const char in_pFieldDocs)
static void	addFieldV (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, ConsoleTypeValidator v, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const char in_pFieldDocs=NULL)
static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const char in_pFieldDocs=NULL)
static void	addDepricatedField (const char *fieldName)
static bool	removeField (const char *in_pFieldname)

Additional Inherited Members
static bool	disableNameChanging = false
Protected Attributes inherited from SimObject
SimObjectId	mId
	Id number for this object.
StringTableEntry	mIdString
Namespace *	mNameSpace
U32	mTypeMask
S32	mScriptCallbackGuard
	Whether the object is executing a script callback.
bool	mCanSaveFieldDictionary
	true if dynamic fields (added at runtime) should be saved, defaults to true
StringTableEntry	mInternalName
	Stores object Internal Name.
StringTableEntry	mClassName
	Stores the class name to link script class namespaces.
StringTableEntry	mSuperClassName
	Stores super class name to link script class namespaces.
static SimObject::Notify *	mNotifyFreeList = NULL

Member Enumeration Documentation

◆ TextureFilterMode

enum TextureFilterMode

Texture Filter Mode.

Enumerator
FILTER_NEAREST
FILTER_BILINEAR
FILTER_INVALID

Constructor & Destructor Documentation

◆ ImageAsset()

ImageAsset ( )

◆ ~ImageAsset()

~ImageAsset ( )

virtual

Member Function Documentation

◆ addExplicitCell()

bool addExplicitCell	(	const S32	cellOffsetX,
		const S32	cellOffsetY,
		const S32	cellWidth,
		const S32	cellHeight,
		const char *	regionName )

◆ addLayer()

void addLayer	(	const char *	imagePath,
		const Point2I	position,
		const ColorF	blendColor,
		const bool	doRedraw = true )

Layers.

◆ bindImageTexture()

const void bindImageTexture ( void )

inline

◆ clearExplicitCells()

bool clearExplicitCells ( void )

Explicit cell control.

◆ containsFrame()

bool containsFrame ( const char * namedFrame )

inline

◆ containsNamedRegion()

bool containsNamedRegion ( const char * regionName )

◆ copyAssetStateTo()

void copyAssetStateTo ( AssetBase * pTarget )

virtual

The state a copy has to carry that no persist field describes.

copyTo copies every persist field generically, off the field table, so an asset only overrides this if it keeps state somewhere else – which in practice means the state it writes as TAML custom nodes, or its Taml children. ImageAsset's explicit cells and image layers and ParticleAsset's emitters are the whole list; the other asset types need nothing here.

Reimplemented from AssetBase.

◆ DECLARE_CONOBJECT()

DECLARE_CONOBJECT ( ImageAsset )

Declare Console Object.

◆ forceCalculation()

void forceCalculation ( void )

inline

◆ forceRedrawImage()

void forceRedrawImage ( )

inline

◆ getBlendColor()

const ColorF getBlendColor ( )

◆ getCellByName()

ImageAsset::FrameArea & getCellByName ( const char * cellName )

◆ getCellCountX()

S32 getCellCountX ( void ) const

inline

◆ getCellCountY()

S32 getCellCountY ( void ) const

inline

◆ getCellHeight()

S32 getCellHeight ( void ) const

inline

◆ getCellOffsetX()

S32 getCellOffsetX ( void ) const

inline

◆ getCellOffsetY()

S32 getCellOffsetY ( void ) const

inline

◆ getCellRowOrder()

bool getCellRowOrder ( void ) const

inline

◆ getCellStrideX()

S32 getCellStrideX ( void ) const

inline

◆ getCellStrideY()

S32 getCellStrideY ( void ) const

inline

◆ getCellWidth()

S32 getCellWidth ( void ) const

inline

◆ getExplicitCellCount()

S32 getExplicitCellCount ( void ) const

inline

◆ getExplicitCellHeight()

S32 getExplicitCellHeight ( const S32 cellIndex )

◆ getExplicitCellIndex()

S32 getExplicitCellIndex ( const char * regionName )

◆ getExplicitCellName()

StringTableEntry getExplicitCellName ( const S32 cellIndex )

◆ getExplicitCellOffset()

Vector2 getExplicitCellOffset ( const S32 cellIndex )

◆ getExplicitCellWidth()

S32 getExplicitCellWidth ( const S32 cellIndex )

◆ getExplicitMode()

bool getExplicitMode ( void ) const

inline

◆ getFilterMode()

TextureFilterMode getFilterMode ( void ) const

inline

◆ getFilterModeDescription()

const char * getFilterModeDescription ( ImageAsset::TextureFilterMode filterMode )

static

◆ getFilterModeEnum()

ImageAsset::TextureFilterMode getFilterModeEnum ( const char * label )

static

◆ getForce16Bit()

bool getForce16Bit ( void ) const

inline

◆ getFrameCount()

U32 getFrameCount ( void ) const

inline

◆ getImageFile() [1/2]

const char * getImageFile	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ getImageFile() [2/2]

StringTableEntry getImageFile ( void ) const

inline

◆ getImageFrameArea() [1/2]

const FrameArea & getImageFrameArea ( const char * namedFrame )

inline

◆ getImageFrameArea() [2/2]

const FrameArea & getImageFrameArea ( U32 frame ) const

inline

◆ getImageHeight()

S32 getImageHeight ( void ) const

inline

◆ getImageTexture()

TextureHandle & getImageTexture ( void )

inline

◆ getImageWidth()

S32 getImageWidth ( void ) const

inline

◆ getLayerBlendColor()

const ColorF getLayerBlendColor ( const U32 index )

◆ getLayerCount()

const U32 getLayerCount ( )

inline

◆ getLayerImage()

const char * getLayerImage ( const U32 index )

◆ getLayerPosition()

const Point2I getLayerPosition ( const U32 index )

◆ getRelativeImageFile()

StringTableEntry getRelativeImageFile ( void ) const

inline

◆ initializeAsset()

void initializeAsset ( void )

protectedvirtual

Reimplemented from AssetBase.

◆ initPersistFields()

void initPersistFields ( )

static

Core.

◆ insertExplicitCell()

bool insertExplicitCell	(	const S32	cellIndex,
		const S32	cellOffsetX,
		const S32	cellOffsetY,
		const S32	cellWidth,
		const S32	cellHeight,
		const char *	regionName )

◆ insertLayer()

void insertLayer	(	const U32	index,
		const char *	imagePath,
		const Point2I	position,
		const ColorF	blendColor,
		const bool	doRedraw = true )

◆ isAssetValid()

virtual bool isAssetValid ( void ) const

inlinevirtual

Reimplemented from AssetBase.

◆ loadTamlExplicitCells()

void loadTamlExplicitCells ( const TamlCustomNodes & customNodes )

protectedvirtual

◆ loadTamlImageLayers()

void loadTamlImageLayers ( const TamlCustomNodes & customNodes )

protectedvirtual

◆ moveLayerBackward()

void moveLayerBackward	(	const U32	index,
		const bool	doRedraw = true )

◆ moveLayerForward()

void moveLayerForward	(	const U32	index,
		const bool	doRedraw = true )

◆ moveLayerToBack()

void moveLayerToBack	(	const U32	index,
		const bool	doRedraw = true )

◆ moveLayerToFront()

void moveLayerToFront	(	const U32	index,
		const bool	doRedraw = true )

◆ nextAvailableCellName()

StringTableEntry nextAvailableCellName	(	const Vector< StringTableEntry > &	used,
		const S32	seedIndex )

static

The first "Frame<N>" at or after seedIndex that nobody in used is already called. Static, and takes its whole world, because naming is arithmetic over a set of strings and needs no texture – which is the only way it can be unit tested, since a test has no GL context to load a bitmap into.

◆ onAdd()

bool onAdd ( void )

virtual

Called when the object is added to the sim.

Reimplemented from SimObject.

◆ onAssetRefresh()

void onAssetRefresh ( void )

protectedvirtual

Reimplemented from AssetBase.

◆ onRemove()

void onRemove ( )

virtual

Called when the object is removed from the sim.

Reimplemented from SimObject.

◆ onTamlCustomRead()

void onTamlCustomRead ( const TamlCustomNodes & customNodes )

protectedvirtual

Called during the reading of the object to allow custom properties to be read.

Reimplemented from SimObject.

◆ onTamlCustomWrite()

void onTamlCustomWrite ( TamlCustomNodes & customNodes )

protectedvirtual

Called during the writing of the object to allow custom properties to be written.

Reimplemented from SimObject.

◆ onTamlPostWrite()

void onTamlPostWrite ( void )

protectedvirtual

Called after Taml has finished writing the object.

Reimplemented from SimObject.

◆ onTamlPreWrite()

void onTamlPreWrite ( void )

protectedvirtual

Taml callbacks.

Reimplemented from SimObject.

◆ removeExplicitCell() [1/2]

bool removeExplicitCell ( const char * regionName )

◆ removeExplicitCell() [2/2]

bool removeExplicitCell ( const S32 cellIndex )

◆ removeLayer()

void removeLayer	(	const U32	index,
		const bool	doRedraw = true )

◆ setBlendColor() [1/2]

void setBlendColor	(	const ColorF	color,
		const bool	doRedraw = true )

◆ setBlendColor() [2/2]

bool setBlendColor	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellCountX() [1/2]

void setCellCountX ( const S32 cellCountX )

◆ setCellCountX() [2/2]

bool setCellCountX	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellCountY() [1/2]

void setCellCountY ( const S32 cellCountY )

◆ setCellCountY() [2/2]

bool setCellCountY	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellHeight() [1/2]

void setCellHeight ( const S32 cellheight )

◆ setCellHeight() [2/2]

bool setCellHeight	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellOffsetX() [1/2]

void setCellOffsetX ( const S32 cellOffsetX )

◆ setCellOffsetX() [2/2]

bool setCellOffsetX	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellOffsetY() [1/2]

void setCellOffsetY ( const S32 cellOffsetY )

◆ setCellOffsetY() [2/2]

bool setCellOffsetY	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellRowOrder() [1/2]

void setCellRowOrder ( const bool cellRowOrder )

◆ setCellRowOrder() [2/2]

bool setCellRowOrder	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellStrideX() [1/2]

void setCellStrideX ( const S32 cellStrideX )

◆ setCellStrideX() [2/2]

bool setCellStrideX	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellStrideY() [1/2]

void setCellStrideY ( const S32 cellStrideY )

◆ setCellStrideY() [2/2]

bool setCellStrideY	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setCellWidth() [1/2]

void setCellWidth ( const S32 cellWidth )

◆ setCellWidth() [2/2]

bool setCellWidth	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setExplicitCell()

bool setExplicitCell	(	const S32	cellIndex,
		const S32	cellOffsetX,
		const S32	cellOffsetY,
		const S32	cellWidth,
		const S32	cellHeight,
		const char *	regionName )

◆ setExplicitMode() [1/2]

void setExplicitMode ( const bool explicitMode )

◆ setExplicitMode() [2/2]

bool setExplicitMode	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setFilterMode() [1/2]

void setFilterMode ( const TextureFilterMode filterMode )

◆ setFilterMode() [2/2]

bool setFilterMode	(	void *	obj,
		const char *	data )

staticprotected

◆ setForce16Bit() [1/2]

void setForce16Bit ( const bool force16Bit )

◆ setForce16Bit() [2/2]

bool setForce16Bit	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setImageFile() [1/2]

void setImageFile ( const char * pImageFile )

◆ setImageFile() [2/2]

bool setImageFile	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ setLayerBlendColor()

void setLayerBlendColor	(	const U32	index,
		const ColorF	color,
		const bool	doRedraw = true )

◆ setLayerImage()

void setLayerImage	(	const U32	index,
		const char *	imagePath,
		const bool	doRedraw = true )

◆ setLayerPosition()

void setLayerPosition	(	const U32	index,
		const Point2I	position,
		const bool	doRedraw = true )

◆ textureEventCallback()

void textureEventCallback	(	const U32	eventCode,
		void *	userData )

staticprotected

◆ writeBlendColor()

bool writeBlendColor	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellCountX()

bool writeCellCountX	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellCountY()

bool writeCellCountY	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellHeight()

bool writeCellHeight	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellOffsetX()

bool writeCellOffsetX	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellOffsetY()

bool writeCellOffsetY	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellRowOrder()

bool writeCellRowOrder	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellStrideX()

bool writeCellStrideX	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellStrideY()

bool writeCellStrideY	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeCellWidth()

bool writeCellWidth	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeExplicitMode()

bool writeExplicitMode	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeFilterMode()

bool writeFilterMode	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeForce16Bit()

bool writeForce16Bit	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

◆ writeImageFile()

bool writeImageFile	(	void *	obj,
		StringTableEntry	pFieldName )

inlinestaticprotected

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

2d/assets/ImageAsset.h
2d/assets/ImageAsset.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ TextureFilterMode

Constructor & Destructor Documentation

◆ ImageAsset()

◆ ~ImageAsset()

Member Function Documentation

◆ addExplicitCell()

◆ addLayer()

◆ bindImageTexture()

◆ clearExplicitCells()

◆ containsFrame()

◆ containsNamedRegion()

◆ copyAssetStateTo()

◆ DECLARE_CONOBJECT()

◆ forceCalculation()

◆ forceRedrawImage()

◆ getBlendColor()

◆ getCellByName()

◆ getCellCountX()

◆ getCellCountY()

◆ getCellHeight()

◆ getCellOffsetX()

◆ getCellOffsetY()

◆ getCellRowOrder()

◆ getCellStrideX()

◆ getCellStrideY()

◆ getCellWidth()

◆ getExplicitCellCount()

◆ getExplicitCellHeight()

◆ getExplicitCellIndex()

◆ getExplicitCellName()

◆ getExplicitCellOffset()

◆ getExplicitCellWidth()

◆ getExplicitMode()

◆ getFilterMode()

◆ getFilterModeDescription()

◆ getFilterModeEnum()

◆ getForce16Bit()

◆ getFrameCount()

◆ getImageFile() [1/2]

◆ getImageFile() [2/2]

◆ getImageFrameArea() [1/2]

◆ getImageFrameArea() [2/2]

◆ getImageHeight()

◆ getImageTexture()

◆ getImageWidth()

◆ getLayerBlendColor()

◆ getLayerCount()

◆ getLayerImage()

◆ getLayerPosition()

◆ getRelativeImageFile()

◆ initializeAsset()

◆ initPersistFields()

◆ insertExplicitCell()

◆ insertLayer()

◆ isAssetValid()

◆ loadTamlExplicitCells()

◆ loadTamlImageLayers()

◆ moveLayerBackward()

◆ moveLayerForward()

◆ moveLayerToBack()

◆ moveLayerToFront()

◆ nextAvailableCellName()

◆ onAdd()

◆ onAssetRefresh()

◆ onRemove()

◆ onTamlCustomRead()

◆ onTamlCustomWrite()

◆ onTamlPostWrite()

◆ onTamlPreWrite()

◆ removeExplicitCell() [1/2]

◆ removeExplicitCell() [2/2]

◆ removeLayer()