#include <guiSpriteCtrl.h>

Inheritance diagram for GuiSpriteCtrl:

Public Member Functions
	GuiSpriteCtrl ()

virtual	~GuiSpriteCtrl ()

bool	onWake ()
	Called when this object is asked to wake up returns true if it's actually awake at the end.

void	onSleep ()
	Called when this object is asked to sleep.

virtual void	copyTo (SimObject *object)

void	onRender (Point2I offset, const RectI &updateRect)

void	RenderImage (RectI &bounds, Point2I &offset, Point2I &size)

void	RenderTiledImage (RectI &bounds, Point2I &start, Point2I &size)

Point2I	constrain (Point2I &point, bool grow=true)

Point2I	constrainLockX (Point2I &point)

Point2I	constrainLockY (Point2I &point)

F32	getAspectRatio ()

Point2I	applyAlignment (RectI &bounds, Point2I &size)

void	moveTo (S32 x, S32 y, S32 time, EasingFunction ease=Linear)

void	growTo (S32 x, S32 y, S32 time, EasingFunction ease=Linear)

void	fadeTo (const ColorI &color, S32 time, EasingFunction ease=Linear)

bool	animateMoveTo ()

bool	animateGrowTo ()

bool	animateFadeTo ()

bool	setImage (const char *pImageAssetId)

virtual bool	setImage (const char *pImageAssetId, const U32 frame)

virtual bool	setImage (const char pImageAssetId, const char pNamedFrame)

StringTableEntry	getImage (void) const

virtual bool	setImageFrame (const U32 frame)

U32	getImageFrame (void) const

virtual bool	setNamedImageFrame (const char *namedFrame)

StringTableEntry	getNamedImageFrame (void) const

virtual bool	setAnimation (const char *pAnimationAssetId)
	Animated-Image Frame.

StringTableEntry	getAnimation (void) const

bool	getTileImage ()

void	setTileImage (bool setting)

Point2I	getPositionOffset ()

void	setPositionOffset (S32 x, S32 y)

ColorI	getImageColor ()

void	setImageColor (ColorI color)

Point2I	getImageSize ()

void	setImageSize (Point2I size)

bool	getFullSize ()

void	setFullSize (bool isFull)

bool	getClampImage ()

void	setClampImage (bool clamp)

bool	getConstrainProportions ()

void	setConstrainProportions (bool setting)

bool	getSingleFrameBitmap ()

void	setSingleFrameBitmap (bool isSingleFrame)

void	setBitmap (const char *name)

void	setBitmap (const TextureHandle &handle)

StringTableEntry	getBitmapName (void) const

U32	constructBitmapArray ()

U32	getBitmapFrame ()

bool	usesAsset ()

	DECLARE_CONOBJECT (GuiSpriteCtrl)

Public Member Functions inherited from GuiControl
virtual bool	isEditMode ()

virtual bool	isEditSelected ()

virtual void	getScrollLineSizes (U32 rowHeight, U32 columnWidth)

virtual void	getCursor (GuiCursor *&cursor, bool &showCursor, const GuiEvent &lastGuiEvent)

void	awaken ()
	Called when this control and its children have been wired up.

void	sleep ()
	Called when this control is no more.

void	preRender ()
	Prerender this control and all its children.

bool	sendScriptMouseEvent (const char *name, const GuiEvent &event)

bool	sendScriptKeyEvent (const char *name, const InputEvent &event)

virtual bool	onInputEvent (const InputEvent &event)
	General input handler.

virtual void	onFocus (bool foundFirstResponder)

virtual bool	ControlIsChild (GuiControl *child)

virtual void	setControlProfile (GuiControlProfile *prof)

virtual void	onAction ()
	Occurs when this control performs its "action".

void	renderText (const Point2I &offset, const Point2I &extent, const char text, GuiControlProfile profile, TextRotationOptions rot=tRotateNone)

virtual void	renderLineList (const Point2I &offset, const Point2I &extent, const S32 startOffsetY, const vector< string > lineList, GuiControlProfile *profile, const TextRotationOptions rot=tRotateNone)

virtual vector< string >	getLineList (const char text, GuiControlProfile profile, S32 totalWidth)

virtual void	renderTextLine (const Point2I &startPoint, const string line, GuiControlProfile *profile, F32 rotationInDegrees, U32 ibeamPosAtLineStart, U32 lineNumber)

RectI	applyMargins (Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
	Returns a new rect based on the margins.

RectI	applyBorders (Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
	Returns the bounds of the rect after considering the borders.

RectI	applyPadding (Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)
	Returns the bounds of the rect this time with padding.

RectI	getInnerRect (GuiControlState currentState=GuiControlState::NormalState)
	Returns the bounds of the rect with margin, borders, and padding applied.

RectI	getInnerRect (Point2I &offset, GuiControlState currentState=GuiControlState::NormalState)

virtual RectI	getInnerRect (Point2I &offset, Point2I &extent, GuiControlState currentState, GuiControlProfile *profile)

Point2I	getOuterExtent (Point2I &innerExtent, GuiControlState currentState, GuiControlProfile *profile)
	Returns the extent of the outer rect given the extent of the inner rect.

S32	getOuterWidth (S32 innerExtent, GuiControlState currentState, GuiControlProfile *profile)

S32	getOuterHeight (S32 innerExtent, GuiControlState currentState, GuiControlProfile *profile)

virtual void	inspectPostApply ()

virtual void	inspectPreApply ()

Point2I	extentBattery (Point2I &newExtent)

void	resetStoredExtent ()

Point2F	relPosBatteryH (S32 pos, S32 ext, S32 parentExt)

Point2F	relPosBatteryV (S32 pos, S32 ext, S32 parentExt)

void	relPosBattery (Point2F &battery, S32 pos, S32 ext, S32 parentExt)

void	resetStoredRelPos ()

virtual void	setDataField (StringTableEntry slotName, const char array, const char value)

void	setSizing (S32 horz, S32 vert)

void	write (Stream &stream, U32 tabStop, U32 flags)
	Overrides Parent Serialization to allow specific controls to not be saved (Dynamic Controls, etc)

bool	getCanSave ()
	Returns boolean specifying if a control can be serialized.

void	setCanSave (bool bCanSave)
	Set serialization flag.

bool	getCanSaveParent ()
	Returns boolean as to whether any parent of this control has the 'no serialization' flag set.

virtual void	setVisible (bool value)

bool	isVisible ()
	Returns true if the object is visible.

virtual void	setActive (bool value)

bool	isActive ()
	Returns true if this control is active.

bool	isAwake ()
	Returns true if this control is awake.

virtual void	addObject (SimObject *obj)

void	removeObject (SimObject *obj)

GuiControl *	getParent ()
	Returns the control which owns this one.

GuiCanvas *	getRoot ()
	Returns the root canvas of this control.

virtual Point2I	localToGlobalCoord (const Point2I &src)

virtual Point2I	globalToLocalCoord (const Point2I &src)

virtual void	resize (const Point2I &newPosition, const Point2I &newExtent)

virtual void	setPosition (const Point2I &newPosition)

virtual void	setExtent (const Point2I &newExtent)

virtual void	setBounds (const RectI &newBounds)

virtual void	setLeft (S32 newLeft)

virtual void	setTop (S32 newTop)

virtual void	setWidth (S32 newWidth)

virtual void	setHeight (S32 newHeight)

virtual void	childResized (GuiControl *child)

virtual void	childMoved (GuiControl *child)

virtual void	childrenReordered ()
	Called when the children of this control may have been reordered.

virtual void	parentResized (const Point2I &oldParentExtent, const Point2I &newParentExtent)

void	preventResizeModeFill ()
	Removes the resize mode of fill and changes it to right or bottom.

void	preventResizeModeCenter ()
	Removes the resize mode of center and changes it to right or bottom.

virtual bool	renderTooltip (Point2I &cursorPos, const char *tipText=NULL)

virtual void	renderChildControls (const Point2I &offset, const RectI &content, const RectI &updateRect)

virtual void	renderChild (GuiControl *ctrl, const Point2I &offset, const RectI &content, const RectI &clipRect)
	Renders a single child control.

void	setUpdateRegion (Point2I pos, Point2I ext)

virtual void	setUpdate ()
	Sets the update area of the control to encompass the whole control.

virtual void	onPreRender ()
	Do special pre-render proecessing.

virtual void	onRemove ()
	Called when this object is removed using delete.

virtual void	onGroupRemove ()
	Called when this object is removed using delete or parent.remove().

virtual bool	onAdd ()
	Called when this object is added to the scene.

virtual void	onChildAdded (GuiControl *child)
	Called when this object has a new child. Congratulations!

virtual void	onChildRemoved (GuiControl *child)
	Called when a child is removed.

virtual bool	pointInControl (const Point2I &parentCoordPoint)

bool	cursorInControl ()
	Returns true if the global cursor is inside this control.

virtual GuiControl *	findHitControl (const Point2I &pt, S32 initialLayer=-1)

virtual void	mouseLock (GuiControl *lockingControl)

virtual void	mouseLock ()
	Turn on mouse locking with last used lock control.

virtual void	mouseUnlock ()
	Unlock the mouse.

virtual bool	isMouseLocked ()
	Returns true if the mouse is locked.

virtual void	onTouchUp (const GuiEvent &event)

virtual void	onTouchDown (const GuiEvent &event)

virtual void	onTouchMove (const GuiEvent &event)

virtual void	onTouchDragged (const GuiEvent &event)

virtual void	onTouchEnter (const GuiEvent &event)

virtual void	onTouchLeave (const GuiEvent &event)

virtual void	onMouseWheelUp (const GuiEvent &event)

virtual void	onMouseWheelDown (const GuiEvent &event)

virtual void	onRightMouseDown (const GuiEvent &event)

virtual void	onRightMouseUp (const GuiEvent &event)

virtual void	onRightMouseDragged (const GuiEvent &event)

virtual void	onMiddleMouseDown (const GuiEvent &event)

virtual void	onMiddleMouseUp (const GuiEvent &event)

virtual void	onMiddleMouseDragged (const GuiEvent &event)

virtual bool	onMouseDownEditor (const GuiEvent &event, const Point2I &offset)

virtual bool	onMouseUpEditor (const GuiEvent &event, const Point2I &offset)

virtual bool	onRightMouseDownEditor (const GuiEvent &event, const Point2I &offset)

virtual bool	onMouseDraggedEditor (const GuiEvent &event, const Point2I &offset)

virtual GuiControl *	findFirstTabable ()
	Find the first tab-accessable child of this control.

virtual GuiControl *	findLastTabable (bool firstCall=true)

virtual GuiControl *	findPrevTabable (GuiControl *curResponder, bool firstCall=true)

virtual GuiControl *	findNextTabable (GuiControl *curResponder, bool firstCall=true)

virtual void	setFirstResponder (GuiControl *firstResponder)

virtual void	makeFirstResponder (bool value)

bool	isFirstResponder ()
	Returns true if this control is a first responder.

virtual void	setFirstResponder ()
	Sets this object to be a first responder.

void	clearFirstResponder ()
	Clears the first responder for this chain.

void	clearFirstResponder (GuiControl *target)

GuiControl *	getFirstResponder ()
	Returns the first responder for this chain.

virtual void	onLoseFirstResponder ()
	Occurs when the first responder for this chain is lost.

void	addAcceleratorKey ()
	Adds the accelerator key for this object to the canvas.

virtual void	buildAcceleratorMap ()

virtual void	acceleratorKeyPress (U32 index)

virtual void	acceleratorKeyRelease (U32 index)

virtual bool	onKeyDown (const GuiEvent &event)

virtual bool	onKeyUp (const GuiEvent &event)

virtual bool	onKeyRepeat (const GuiEvent &event)

void	messageSiblings (S32 message)
	Send a message to all siblings.

virtual void	onMessage (GuiControl *sender, S32 msg)
	Receive a message from another control.

virtual void	onDialogPush ()
	Called if this object is a dialog, when it is added to the visible layers.

virtual void	onDialogPop ()
	Called if this object is a dialog, when it is removed from the visible layers.

void	setConsoleVariable (const char *variable)

void	setConsoleCommand (const char *newCmd)

const char *	getConsoleCommand ()
	Returns the name of the function bound to this GuiControl.

LangTable *	getGUILangTable (void)

const UTF8 *	getGUIString (S32 id)

virtual const char *	getScriptValue ()
	Returns the value of the variable bound to this object.

virtual void	setScriptValue (const char *value)
	Sets the value of the variable bound to this object.

	DECLARE_CONOBJECT (GuiControl)

	GuiControl ()

virtual	~GuiControl ()

const Point2I &	getPosition ()
	Returns position of the control.

const Point2I &	getExtent ()
	Returns extents of the control.

const RectI &	getBounds ()
	Returns the bounds of the control.

const Point2I &	getMinExtent ()
	Returns minimum size the control can be.

const S32	getLeft ()
	Returns the X position of the control.

const S32	getTop ()
	Returns the Y position of the control.

const S32	getWidth ()
	Returns the width of the control.

const S32	getHeight ()
	Returns the height of the control.

virtual void	setText (const char *text)

virtual void	setTextID (S32 id)

virtual void	setTextID (const char *id)

virtual const char *	getText ()

void	setTextWrap (const bool wrap)

bool	getTextWrap ()

void	setTextExtend (const bool extend)

bool	getTextExtend ()

const horizSizingOptions	getHorizSizing ()

const vertSizingOptions	getVertSizing ()

void	setHorizSizing (const horizSizingOptions sizing)

void	setVertSizing (const vertSizingOptions sizing)

Public Member Functions inherited from SimGroup
	~SimGroup ()

void	addObject (SimObject *, SimObjectId)

void	addObject (SimObject , const char name)

virtual void	onChildRemoved (SimObject *)

virtual SimObject *	findObject (const char *name)
	Find an object in the group.

bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3))

	DECLARE_CONOBJECT (SimGroup)

Public Member Functions inherited from SimSet
	SimSet ()

	~SimSet ()

virtual void	onDeleteNotify (SimObject *object)

virtual U32	getTamlChildCount (void) const
	Called when Taml attempts to compile a list of children.

virtual SimObject *	getTamlChild (const U32 childIndex) const
	Called when Taml attempts to compile a list of children.

virtual void	addTamlChild (SimObject *pSimObject)
	Called when Taml attempts to populate an objects children during a read.

void	callOnChildren (const char method, S32 argc, const char argv[], bool executeOnChildGroups=true)

SimObject *	findObjectByInternalName (const char *internalName, bool searchChildren=false)

virtual bool	writeObject (Stream *stream)

virtual bool	readObject (Stream *stream)

void	lock ()

void	unlock ()

	DECLARE_CONOBJECT (SimSet)

void	_setVectorAssoc (const char *file, const U32 line)

virtual void	pushObject (SimObject *)

virtual void	popObject ()
	Remove an object from the end of the list.

void	bringObjectToFront (SimObject *obj)

void	pushObjectToBack (SimObject *obj)

SimObject *	front ()

SimObject *	first ()

SimObject *	last ()

bool	empty ()

S32	size () const

iterator	begin ()

iterator	end ()

value	operator[] (S32 index)

iterator	find (iterator first, iterator last, SimObject *obj)

iterator	find (SimObject *obj)

template<typename T >
bool	containsType (void)

bool	isMember (SimObject *obj)

virtual bool	reOrder (SimObject obj, SimObject target=0)

SimObject *	at (S32 index) const

void	deleteObjects (void)

void	clear ()

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)

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)

template<typename T >
bool	isType (void)

virtual bool	handlesConsoleMethod (const char fname, S32 routingId)

	DECLARE_CONOBJECT (SimObject)

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)

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 void	onGroupAdd ()
	Called when the object is added to 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	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 *)

virtual bool	writeField (StringTableEntry fieldname, const char *value)

virtual void	writeFields (Stream &stream, U32 tabStop)

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	assignDynamicFieldsFrom (SimObject *obj)

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

Public Member Functions inherited from Tickable
	Tickable ()

virtual	~Tickable ()

virtual bool	isProcessingTicks () const

Public Member Functions inherited from ImageFrameProvider
	ImageFrameProvider ()

virtual	~ImageFrameProvider ()

Public Member Functions inherited from ImageFrameProviderCore
	ImageFrameProviderCore ()

virtual	~ImageFrameProviderCore ()

void	allocateAssets (AssetPtr< ImageAsset > pImageAssetPtr, AssetPtr< AnimationAsset > pAnimationAssetPtr)

void	deallocateAssets (void)

virtual void	copyTo (ImageFrameProviderCore *pImageFrameProviderCore) const

virtual void	setProcessTicks (bool tick)

bool	updateAnimation (const F32 elapsedTime)

virtual bool	validRender (void) const

virtual void	render (const bool flipX, const bool flipY, const Vector2 &vertexPos0, const Vector2 &vertexPos1, const Vector2 &vertexPos2, const Vector2 &vertexPos3, BatchRender *pBatchRenderer) const

virtual void	render (const bool flipX, const bool flipY, const Vector2 &vertexPos0, const Vector2 &vertexPos1, const Vector2 &vertexPos2, const Vector2 &vertexPos3, const Vector2 &uvPos0, const Vector2 &uvPos1, const Vector2 &uvPos2, const Vector2 &uvPos3, BatchRender *pBatchRenderer) const

void	render (const U32 vertexCount, const Vector2 vertexArray, const Vector2 textureArray, const ColorF colorArray, BatchRender pBatchRenderer) const

void	renderGui (GuiControl &owner, Point2I offset, const RectI &updateRect) const

bool	setImage (const char *pImageAssetId)
	Static-Image Frame.

StringTableEntry	getImage (void) const

U32	getImageFrame (void) const

StringTableEntry	getNamedImageFrame (void) const

StringTableEntry	getAnimation (void) const

void	setAnimationFrame (const U32 frameIndex)

S32	getAnimationFrame (void) const

void	setAnimationTimeScale (const F32 scale)

F32	getAnimationTimeScale (void) const

bool	playAnimation (const AssetPtr< AnimationAsset > &animationAsset)

void	pauseAnimation (const bool animationPaused)

void	stopAnimation (void)

void	resetAnimationTime (void)

bool	isAnimationPaused (void) const

bool	isAnimationFinished (void) const

bool	isAnimationValid (void) const

bool	isStaticFrameProvider (void) const
	Frame provision.

bool	isUsingNamedImageFrame (void) const

TextureHandle &	getProviderTexture (void) const

const ImageAsset::FrameArea &	getProviderImageFrameArea (void) const

const AnimationAsset *	getCurrentAnimation (void) const

const StringTableEntry	getCurrentAnimationAssetId (void) const

const U32	getCurrentAnimationFrame (void) const

const char *	getCurrentNamedAnimationFrame (void) const

const F32	getCurrentAnimationTime (void) const

void	clearAssets (void)

virtual void	resetState (void)

Static Public Member Functions
static void	initPersistFields ()

Static Public Member Functions inherited from GuiControl
static void	initPersistFields ()

static bool	setTextProperty (void obj, const char data)

static const char *	getTextProperty (void obj, const char data)

static bool	writeTextWrapFn (void obj, const char data)

static bool	writeTextExtendFn (void obj, const char data)

static bool	setExtentFn (void obj, const char data)

static bool	setMinExtentFn (void obj, const char data)

static bool	writeMinExtentFn (void obj, const char data)

static bool	setPositionFn (void obj, const char data)

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)

Static Public Member Functions inherited from Tickable
static bool	advanceTime (U32 timeDelta)

Protected Member Functions
virtual bool	update (const F32 elapsedTime)
	Integration.

virtual void	onAnimationEnd (void)

virtual void	processTick ()

virtual void	interpolateTick (F32 delta)

virtual void	advanceTime (F32 timeDelta)

RectI	getSourceRect (TextureObject *texture)

Protected Member Functions inherited from GuiControl
S32	getTextHorizontalOffset (S32 textWidth, S32 totalWidth, AlignmentType align)

S32	getTextVerticalOffset (S32 textHeight, S32 totalHeight, VertAlignmentType align)

AlignmentType	getAlignmentType ()

VertAlignmentType	getVertAlignmentType ()

AlignmentType	getAlignmentType (GuiControlProfile *profile)

VertAlignmentType	getVertAlignmentType (GuiControlProfile *profile)

const ColorI &	getFontColor (GuiControlProfile *profile, const GuiControlState state=GuiControlState::NormalState)

const char *	execConsoleCallback ()
	Executes mConsoleCommand, and returns the result.

const char *	execAltConsoleCallback ()
	Executes mAltConsoleCommand, and returns the result.

void	setVariable (const char *value)

void	setIntVariable (S32 value)

void	setFloatVariable (F32 value)

const char *	getVariable ()
	Returns value of control's bound variable as a string.

S32	getIntVariable ()
	Returns value of control's bound variable as a integer.

F32	getFloatVariable ()
	Returns value of control's bound variable as a float.

Protected Member Functions inherited from SimObject
virtual void	onTamlPreWrite (void)
	Taml callbacks.

virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object.

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.

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.

void	linkNamespaces ()

void	unlinkNamespaces ()

Protected Member Functions inherited from ConsoleObject
	ConsoleObject ()

	ConsoleObject (const ConsoleObject &)

Protected Member Functions inherited from ImageFrameProvider
virtual void	onAssetRefreshed (AssetPtrBase *pAssetPtrBase)

Static Protected Member Functions
static bool	setImage (void obj, const char data)

static bool	writeImage (void *obj, StringTableEntry pFieldName)

static bool	setImageFrame (void obj, const char data)

static bool	writeImageFrame (void *obj, StringTableEntry pFieldName)

static bool	setNamedImageFrame (void obj, const char data)

static bool	writeNamedImageFrame (void *obj, StringTableEntry pFieldName)

static bool	setAnimation (void obj, const char data)

static bool	writeAnimation (void *obj, StringTableEntry pFieldName)

static bool	setBitmapName (void obj, const char data)

static const char *	getBitmapName (void obj, const char data)

static bool	writeBitmapName (void *obj, StringTableEntry pFieldName)

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 SimObject::Notify *	allocNotify ()
	Get a free Notify structure.

static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free.

Static Protected Member Functions inherited from ConsoleObject
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)

Protected Attributes
StringTableEntry	mImageAssetId

U32	mFrame

StringTableEntry	mNamedImageFrameId

StringTableEntry	mAnimationAssetId

StringTableEntry	mBitmapName

TextureHandle	mBitmapTextureHandle

Vector< RectI >	mBitmapArrayRects

bool	mTileImage

Point2I	mPositionOffset

FluidColorI	mImageColor

Point2I	mImageSize

bool	mFullSize

bool	mConstrainProportions

bool	mClampImage

bool	mSingleFrameBitmap

Fluid	mFluidMoveTo

Point2I	mStartOffset

Point2I	mTargetOffset

Fluid	mFluidGrowTo

Point2I	mStartSize

Point2I	mTargetSize

Protected Attributes inherited from GuiControl
bool	mPreviouslyAwake

S32	mHorizSizing
	Set from horizSizingOptions.

S32	mVertSizing
	Set from vertSizingOptions.

Point2I	mStoredExtent

Point2F	mStoredRelativePosH

Point2F	mStoredRelativePosV

bool	mUseRelPosH

bool	mUseRelPosV

StringTableEntry	mConsoleVariable

StringTableEntry	mConsoleCommand

StringTableEntry	mAltConsoleCommand

StringTableEntry	mAcceleratorKey

StringTableEntry	mTooltip

StringTableEntry	mText

StringTableEntry	mTextID

bool	mTextWrap

bool	mTextExtend

AlignmentType	mAlignment

VertAlignmentType	mVAlignment

F32	mFontSizeAdjust

ColorI	mFontColor

bool	mOverrideFontColor

Protected Attributes inherited from SimSet
SimObjectList	objectList

void *	mMutex

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.

Protected Attributes inherited from ImageFrameProvider
AssetPtr< ImageAsset >	mImageAsset

AssetPtr< AnimationAsset >	mAnimationAsset

Protected Attributes inherited from ImageFrameProviderCore
bool	mSelfTick

bool	mStaticProvider

bool	mUsingNamedFrame

U32	mImageFrame

StringTableEntry	mNamedImageFrame

AssetPtr< ImageAsset > *	mpImageAsset

AssetPtr< AnimationAsset > *	mpAnimationAsset

S32	mLastFrameIndex

S32	mCurrentFrameIndex

U32	mMaxFrameIndex

F32	mCurrentTime

F32	mPausedTime

F32	mCurrentModTime

F32	mAnimationTimeScale

F32	mTotalIntegrationTime

F32	mFrameIntegrationTime

bool	mAnimationPaused

bool	mAnimationFinished

Additional Inherited Members
Public Types inherited from GuiControl
enum	horizSizingOptions { horizResizeRight = 0 , horizResizeWidth , horizResizeLeft , horizResizeCenter , horizResizeRelative , horizResizeFill }

enum	vertSizingOptions { vertResizeBottom = 0 , vertResizeHeight , vertResizeTop , vertResizeCenter , vertResizeRelative , vertResizeFill }

enum	TextRotationOptions { tRotateNone = 0 , tRotateLeft , tRotateRight }

Public Types inherited from SimSet
typedef SimObjectList::iterator	iterator

typedef SimObjectList::value_type	value

Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }

Public Attributes inherited from GuiControl
GuiControlProfile *	mProfile

GuiControlProfile *	mTooltipProfile

S32	mTipHoverTime

S32	mTooltipWidth

bool	mVisible

bool	mActive

bool	mAwake

bool	mSetFirstResponder

bool	mCanSave

bool	mIsContainer
	if true, then the GuiEditor can drag other controls into this one.

bool	mUseInput
	True if input events like a click can be passed to this gui. False will pass events to the parent and this object and its children will not process input (touch and keyboard).

S32	mLayer

RectI	mBounds

Point2I	mMinExtent

Point2I	mRenderInsetLT

Point2I	mRenderInsetRB
	Add this to the mBounds and parent offset to get the true render location of the control.

StringTableEntry	mLangTableName
	The actual rendered inset for the right and bottom sides.

LangTable *	mLangTable

GuiControl *	mFirstResponder

Static Public Attributes inherited from GuiControl
static GuiEditCtrl *	smEditorHandle = NULL
	static GuiEditCtrl pointer that gives controls access to editor-NULL if editor is closed

static S32	smCursorChanged = -1
	Has this control modified the cursor? -1 or type.

static bool	smDesignTime = false
	static GuiControl boolean that specifies if the GUI Editor is active

static GuiControl *	smPrevResponder = NULL

static GuiControl *	smCurResponder = NULL

Static Public Attributes inherited from SimObject
static bool	disableNameChanging = false

Static Public Attributes inherited from Tickable
static const U32	smTickShift = 4
	Shift value to control how often Ticks occur.

static const U32	smTickMs = ( 1 << smTickShift )
	Number of milliseconds per tick, 32 in this case.

static const F32	smTickSec = ( F32( Tickable::smTickMs ) / 1000.f )
	Fraction of a second per tick.

static const U32	smTickMask = ( smTickMs - 1 )

Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Constructor & Destructor Documentation

◆ GuiSpriteCtrl()

GuiSpriteCtrl ( void )

◆ ~GuiSpriteCtrl()

~GuiSpriteCtrl ( )

virtual

Member Function Documentation

◆ advanceTime()

virtual void advanceTime ( F32 timeDelta )

inlineprotectedvirtual

This method is called once every frame regardless of the return value of isProcessingTicks and informs the object of the passage of time

Reimplemented from GuiControl.

◆ animateFadeTo()

bool animateFadeTo ( )

◆ animateGrowTo()

bool animateGrowTo ( )

◆ animateMoveTo()

bool animateMoveTo ( )

◆ applyAlignment()

Point2I applyAlignment	(	RectI &	bounds,
		Point2I &	size
	)

◆ constrain()

Point2I constrain	(	Point2I &	point,
		bool	grow = `true`
	)

◆ constrainLockX()

Point2I constrainLockX ( Point2I & point )

◆ constrainLockY()

Point2I constrainLockY ( Point2I & point )

◆ constructBitmapArray()

U32 constructBitmapArray ( )

◆ copyTo()

void copyTo ( SimObject * object )

virtual

Reimplemented from SimObject.

◆ DECLARE_CONOBJECT()

DECLARE_CONOBJECT ( GuiSpriteCtrl )

◆ fadeTo()

void fadeTo	(	const ColorI &	color,
		S32	time,
		EasingFunction	ease = `Linear`
	)

◆ getAnimation()

StringTableEntry getAnimation ( void ) const

inline

◆ getAspectRatio()

F32 getAspectRatio ( )

◆ getBitmapFrame()

U32 getBitmapFrame ( )

inline

◆ getBitmapName() [1/2]

static const char * getBitmapName	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

◆ getBitmapName() [2/2]

StringTableEntry getBitmapName ( void ) const

inline

◆ getClampImage()

bool getClampImage ( )

inline

◆ getConstrainProportions()

bool getConstrainProportions ( )

inline

◆ getFullSize()

bool getFullSize ( )

inline

◆ getImage()

StringTableEntry getImage ( void ) const

inline

◆ getImageColor()

ColorI getImageColor ( )

inline

◆ getImageFrame()

U32 getImageFrame ( void ) const

inline

◆ getImageSize()

Point2I getImageSize ( )

inline

◆ getNamedImageFrame()

StringTableEntry getNamedImageFrame ( void ) const

inline

◆ getPositionOffset()

Point2I getPositionOffset ( )

inline

◆ getSingleFrameBitmap()

bool getSingleFrameBitmap ( )

inline

◆ getSourceRect()

RectI getSourceRect ( TextureObject * texture )

protected

◆ getTileImage()

bool getTileImage ( )

inline

◆ growTo()

void growTo	(	S32	x,
		S32	y,
		S32	time,
		EasingFunction	ease = `Linear`
	)

◆ initPersistFields()

void initPersistFields ( )

static

◆ interpolateTick()

virtual void interpolateTick ( F32 delta )

inlineprotectedvirtual

This method is called every frame and lets the control interpolate between ticks so you can smooth things as long as isProcessingTicks returns true when it is called on the object

Reimplemented from GuiControl.

◆ moveTo()

void moveTo	(	S32	x,
		S32	y,
		S32	time,
		EasingFunction	ease = `Linear`
	)

◆ onAnimationEnd()

void onAnimationEnd ( void )

protectedvirtual

Reimplemented from ImageFrameProviderCore.

◆ onRender()

void onRender	(	Point2I	offset,
		const RectI &	updateRect
	)

virtual

Called when this control is to render itself

Parameters

offset	The location this control is to begin rendering
updateRect	The screen area this control has drawing access to

Reimplemented from GuiControl.

◆ onSleep()

void onSleep ( )

virtual

Called when this object is asked to sleep.

Reimplemented from GuiControl.

◆ onWake()

bool onWake ( )

virtual

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

◆ processTick()

void processTick ( )

protectedvirtual

This method is called once every 32ms if isProcessingTicks returns true when called on the object

Reimplemented from GuiControl.

◆ RenderImage()

void RenderImage	(	RectI &	bounds,
		Point2I &	offset,
		Point2I &	size
	)

◆ RenderTiledImage()

void RenderTiledImage	(	RectI &	bounds,
		Point2I &	start,
		Point2I &	size
	)

◆ setAnimation() [1/2]

bool setAnimation ( const char * pAnimationAssetId )

virtual

Animated-Image Frame.

Reimplemented from ImageFrameProviderCore.

◆ setAnimation() [2/2]

static bool setAnimation	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

◆ setBitmap() [1/2]

void setBitmap ( const char * name )

◆ setBitmap() [2/2]

void setBitmap ( const TextureHandle & handle )

inline

◆ setBitmapName()

static bool setBitmapName	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

◆ setClampImage()

void setClampImage ( bool clamp )

inline

◆ setConstrainProportions()

void setConstrainProportions ( bool setting )

inline

◆ setFullSize()

void setFullSize ( bool isFull )

inline

◆ setImage() [1/4]

bool setImage ( const char * pImageAssetId )

inline

◆ setImage() [2/4]

bool setImage	(	const char *	pImageAssetId,
		const char *	pNamedFrame
	)

virtual

Reimplemented from ImageFrameProviderCore.

◆ setImage() [3/4]

bool setImage	(	const char *	pImageAssetId,
		const U32	frame
	)

virtual

Reimplemented from ImageFrameProviderCore.

◆ setImage() [4/4]

static bool setImage	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

◆ setImageColor()

void setImageColor ( ColorI color )

inline

◆ setImageFrame() [1/2]

bool setImageFrame ( const U32 frame )

virtual

Reimplemented from ImageFrameProviderCore.

◆ setImageFrame() [2/2]

static bool setImageFrame	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

◆ setImageSize()

void setImageSize ( Point2I size )

inline

◆ setNamedImageFrame() [1/2]

bool setNamedImageFrame ( const char * namedFrame )

virtual

Reimplemented from ImageFrameProviderCore.

◆ setNamedImageFrame() [2/2]

static bool setNamedImageFrame	(	void *	obj,
		const char *	data
	)

inlinestaticprotected

◆ setPositionOffset()

void setPositionOffset	(	S32	x,
		S32	y
	)

inline

◆ setSingleFrameBitmap()

void setSingleFrameBitmap ( bool isSingleFrame )

inline

◆ setTileImage()

void setTileImage ( bool setting )

inline

◆ update()

bool update ( const F32 elapsedTime )

protectedvirtual

Integration.

Reimplemented from ImageFrameProviderCore.

◆ usesAsset()

bool usesAsset ( )

inline

◆ writeAnimation()

static bool writeAnimation	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

◆ writeBitmapName()

static bool writeBitmapName	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

◆ writeImage()

static bool writeImage	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

◆ writeImageFrame()

static bool writeImageFrame	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

◆ writeNamedImageFrame()

static bool writeNamedImageFrame	(	void *	obj,
		StringTableEntry	pFieldName
	)

inlinestaticprotected

Member Data Documentation

◆ mAnimationAssetId

StringTableEntry mAnimationAssetId

protected

◆ mBitmapArrayRects

Vector<RectI> mBitmapArrayRects

protected

◆ mBitmapName

StringTableEntry mBitmapName

protected

◆ mBitmapTextureHandle

TextureHandle mBitmapTextureHandle

protected

◆ mClampImage

bool mClampImage

protected

◆ mConstrainProportions

bool mConstrainProportions

protected

◆ mFluidGrowTo

Fluid mFluidGrowTo

protected

◆ mFluidMoveTo

Fluid mFluidMoveTo

protected

◆ mFrame

U32 mFrame

protected

◆ mFullSize

bool mFullSize

protected

◆ mImageAssetId

StringTableEntry mImageAssetId

protected

◆ mImageColor

FluidColorI mImageColor

protected

◆ mImageSize

Point2I mImageSize

protected

◆ mNamedImageFrameId

StringTableEntry mNamedImageFrameId

protected

◆ mPositionOffset

Point2I mPositionOffset

protected

◆ mSingleFrameBitmap

bool mSingleFrameBitmap

protected

◆ mStartOffset

Point2I mStartOffset

protected

◆ mStartSize

Point2I mStartSize

protected

◆ mTargetOffset

Point2I mTargetOffset

protected

◆ mTargetSize

Point2I mTargetSize

protected

◆ mTileImage

bool mTileImage

protected

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

2d/gui/guiSpriteCtrl.h
2d/gui/guiSpriteCtrl.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ GuiSpriteCtrl()

◆ ~GuiSpriteCtrl()

Member Function Documentation

◆ advanceTime()

◆ animateFadeTo()

◆ animateGrowTo()

◆ animateMoveTo()

◆ applyAlignment()

◆ constrain()

◆ constrainLockX()

◆ constrainLockY()

◆ constructBitmapArray()

◆ copyTo()

◆ DECLARE_CONOBJECT()

◆ fadeTo()

◆ getAnimation()

◆ getAspectRatio()

◆ getBitmapFrame()

◆ getBitmapName() [1/2]

◆ getBitmapName() [2/2]

◆ getClampImage()

◆ getConstrainProportions()

◆ getFullSize()

◆ getImage()

◆ getImageColor()

◆ getImageFrame()

◆ getImageSize()

◆ getNamedImageFrame()

◆ getPositionOffset()

◆ getSingleFrameBitmap()

◆ getSourceRect()

◆ getTileImage()

◆ growTo()

◆ initPersistFields()

◆ interpolateTick()

◆ moveTo()

◆ onAnimationEnd()

◆ onRender()

◆ onSleep()

◆ onWake()

◆ processTick()

◆ RenderImage()

◆ RenderTiledImage()

◆ setAnimation() [1/2]

◆ setAnimation() [2/2]

◆ setBitmap() [1/2]

◆ setBitmap() [2/2]

◆ setBitmapName()

◆ setClampImage()

◆ setConstrainProportions()

◆ setFullSize()

◆ setImage() [1/4]

◆ setImage() [2/4]

◆ setImage() [3/4]

◆ setImage() [4/4]

◆ setImageColor()

◆ setImageFrame() [1/2]

◆ setImageFrame() [2/2]

◆ setImageSize()

◆ setNamedImageFrame() [1/2]

◆ setNamedImageFrame() [2/2]

◆ setPositionOffset()

◆ setSingleFrameBitmap()

◆ setTileImage()

◆ update()

◆ usesAsset()

◆ writeAnimation()

◆ writeBitmapName()

◆ writeImage()

◆ writeImageFrame()

◆ writeNamedImageFrame()

Member Data Documentation

◆ mAnimationAssetId