RenderProxy Class Reference

Inherits SimObject, and SimObject.

Methods
string	getAnimation ()
string	getAnimation ()
int	getAnimationFrame ()
int	getAnimationFrame ()
float	getAnimationTime ()
float	getAnimationTime ()
float	getAnimationTimeScale ()
float	getAnimationTimeScale ()
string	getImage ()
string	getImage ()
int	getImageFrame ()
int	getImageFrame ()
bool	getIsAnimationFinished ()
bool	getIsAnimationFinished ()
bool	isStaticFrameProvider ()
bool	isStaticFrameProvider ()
void	pauseAnimation (bool enable)
void	pauseAnimation (bool enable)
bool	playAnimation (string animationAssetId)
bool	playAnimation (string animationAssetId)
void	setAnimationFrame (int frame)
void	setAnimationFrame (int frame)
void	setAnimationTimeScale (float timeScale)
void	setAnimationTimeScale (float timeScale)
bool	setImage (string imageAssetId,[int frame])
bool	setImage (string imageAssetId,[int frame])
bool	setImageFrame (int frame)
bool	setImageFrame (int frame)
void	stopAnimation ()
void	stopAnimation ()
Methods inherited from SimObject
void	addFieldFilter (fieldName)
void	addFieldFilter (fieldName)
string	call (%args)
string	call (%args)
int	clone ([bool copyDynamicFields?=false])
int	clone ([bool copyDynamicFields?=false])
void	delete ()
void	delete ()
void	dump ()
void	dump ()
void	dumpClassHierarchy ()
void	dumpClassHierarchy ()
string	getClassName ()
string	getClassName ()
string	getClassNamespace ()
string	getClassNamespace ()
string	getDynamicField (index)
string	getDynamicField (index)
int	getDynamicFieldCount ()
int	getDynamicFieldCount ()
string	getField (int index)
string	getField (int index)
int	getFieldCount ()
int	getFieldCount ()
string	getFieldType (fieldName)
string	getFieldType (fieldName)
string	getFieldValue (fieldName)
string	getFieldValue (fieldName)
int	getGroup ()
int	getGroup ()
int	getId ()
int	getId ()
string	getInternalName ()
string	getInternalName ()
string	getName ()
string	getName ()
string	getProgenitorFile ()
string	getProgenitorFile ()
string	getSuperClassNamespace ()
string	getSuperClassNamespace ()
int	getType ()
int	getType ()
bool	isChildOfGroup ()
bool	isChildOfGroup ()
bool	isMemberOfClass (string classname)
bool	isMemberOfClass (string classname)
bool	isMethod (string method name)
bool	isMethod (string method name)
bool	isTimerActive ()
bool	isTimerActive ()
void	removeFieldFilter (fieldName)
void	removeFieldFilter (fieldName)
bool	save (fileName,[selectedOnly])
bool	save (fileName,[selectedOnly])
int	schedule (time, command,< arg1...argN >)
int	schedule (time, command,< arg1...argN >)
void	setClassNamespace ()
void	setClassNamespace ()
bool	setFieldValue (fieldName, value)
bool	setFieldValue (fieldName, value)
void	setInternalName ()
void	setInternalName ()
void	setName (newName)
void	setName (newName)
void	setProgenitorFile (file)
void	setProgenitorFile (file)
void	setSuperClassNamespace ()
void	setSuperClassNamespace ()
bool	startTimer (callbackFunction, float timePeriod,[repeat])
bool	startTimer (callbackFunction, float timePeriod,[repeat])
void	stopTimer ()
void	stopTimer ()

Fields
animationAssetPtr	Animation
int	Frame
imageAssetPtr	Image
SimBase
bool	canSaveDynamicFields
string	internalName
SimObjectPtr	parentGroup
Namespace Linking
string	superclass
string	class
Fields inherited from SimObject
bool	canSaveDynamicFields
string	internalName
SimObjectPtr	parentGroup
string	superclass
string	class

Methods

string RenderProxy::getAnimation

(

)

• Gets current animation asset Id.

  Returns

  (string AnimationAssetId) The current animation asset Id.

string RenderProxy::getAnimation

(

)

• Gets current animation asset Id.

  Returns

  (string AnimationAssetId) The current animation asset Id.

int RenderProxy::getAnimationFrame

(

)

• Gets current animation frame.

  Returns

  (int frame) The current animation frame

int RenderProxy::getAnimationFrame

(

)

• Gets current animation frame.

  Returns

  (int frame) The current animation frame

float RenderProxy::getAnimationTime

(

)

• Gets current animation time.

  Returns

  (float time) The current animation time

float RenderProxy::getAnimationTime

(

)

• Gets current animation time.

  Returns

  (float time) The current animation time

float RenderProxy::getAnimationTimeScale

(

)

• Get the animation time scale for this render-proxy.

  Returns

  (float) Returns the animation time scale for this render-proxy.

float RenderProxy::getAnimationTimeScale

(

)

• Get the animation time scale for this render-proxy.

  Returns

  (float) Returns the animation time scale for this render-proxy.

string RenderProxy::getImage

(

)

• Gets current image asset Id.

  Returns

  (string imageAssetId) The image being displayed

string RenderProxy::getImage

(

)

• Gets current image asset Id.

  Returns

  (string imageAssetId) The image being displayed

int RenderProxy::getImageFrame

(

)

• Gets current image Frame.

  Returns

  (int frame) The frame currently being displayed

int RenderProxy::getImageFrame

(

)

• Gets current image Frame.

  Returns

  (int frame) The frame currently being displayed

bool RenderProxy::getIsAnimationFinished

(

)

• Checks animation status.

  Returns

  (bool finished) Whether or not the animation is finished

bool RenderProxy::getIsAnimationFinished

(

)

• Checks animation status.

  Returns

  (bool finished) Whether or not the animation is finished

bool RenderProxy::isStaticFrameProvider

(

)

• Gets whether the render-proxy is in static or dynamic (animated)mode.

  Returns

  Returns whether the render-proxy is in static or dynamic (animated)mode.

bool RenderProxy::isStaticFrameProvider

(

)

• Gets whether the render-proxy is in static or dynamic (animated)mode.

  Returns

  Returns whether the render-proxy is in static or dynamic (animated)mode.

void RenderProxy::pauseAnimation

(

bool

enable

)

• Pause the current animation

  Parameters

  enable

  If true, pause the animation. If false, continue animating

void RenderProxy::pauseAnimation

(

bool

enable

)

• Pause the current animation

  Parameters

  enable

  If true, pause the animation. If false, continue animating

bool RenderProxy::playAnimation

(

string

animationAssetId

)

• Plays an animation.

  Parameters

  animationAssetId

  The animation asset Id to play

  Returns

  Returns true on success.

bool RenderProxy::playAnimation

(

string

animationAssetId

)

• Plays an animation.

  Parameters

  animationAssetId

  The animation asset Id to play

  Returns

  Returns true on success.

void RenderProxy::setAnimationFrame

(

int

frame

)

• Sets the current animation frame.

  Parameters

  frame

  Which frame of the animation to display

  Returns

  No return value.

void RenderProxy::setAnimationFrame

(

int

frame

)

• Sets the current animation frame.

  Parameters

  frame

  Which frame of the animation to display

  Returns

  No return value.

void RenderProxy::setAnimationTimeScale

(

float

timeScale

)

• Change the rate of animation.

  Parameters

  timeScale

  Value which will scale the frame animation speed. 1 by default.

void RenderProxy::setAnimationTimeScale

(

float

timeScale

)

• Change the rate of animation.

  Parameters

  timeScale

  Value which will scale the frame animation speed. 1 by default.

bool RenderProxy::setImage

(

string

imageAssetId

)

• Sets imageAssetId/Frame.

  Parameters

  imageAssetId	The image asset Id to display
  frame	The frame of the image to display

  Returns

  Returns true on success.

bool RenderProxy::setImage

(

string

imageAssetId

)

• Sets imageAssetId/Frame.

  Parameters

  imageAssetId	The image asset Id to display
  frame	The frame of the image to display

  Returns

  Returns true on success.

bool RenderProxy::setImageFrame

(

int

frame

)

• Sets image frame.

  Parameters

  frame

  The frame to display

  Returns

  Returns true on success.

bool RenderProxy::setImageFrame

(

int

frame

)

• Sets image frame.

  Parameters

  frame

  The frame to display

  Returns

  Returns true on success.

void RenderProxy::stopAnimation

(

)

• Stop the current animation

  Returns

  No return value.

void RenderProxy::stopAnimation

(

)

• Stop the current animation

  Returns

  No return value.

Member Data Documentation

animationAssetPtr RenderProxy::Animation

bool RenderProxy::canSaveDynamicFields

string RenderProxy::class

Script SuperClass of object.

int RenderProxy::Frame

imageAssetPtr RenderProxy::Image

string RenderProxy::internalName

SimObjectPtr RenderProxy::parentGroup

Group hierarchy parent of the object.

string RenderProxy::superclass

Script Class of object.