torque Torque Game Engine Documentation
TGE Version 1.5.2

fxRenderObject Class Reference

#include <fxRenderObject.h>

Inheritance diagram for fxRenderObject:

Inheritance graph
[legend]

Public Member Functions

 fxRenderObject ()
 ~fxRenderObject ()
void renderObject (SceneState *, SceneRenderImage *)
 Called when the object is supposed to render itself.
virtual bool prepRenderImage (SceneState *, const U32 stateKey, const U32 startZone, const bool modifyBaseZoneState=false)
 Called when the SceneGraph is ready for the registration of RenderImages.
bool onAdd ()
 Called when the object is added to the sim.
void onRemove ()
 Called when the object is removed from the sim.
void onEditorEnable ()
 Called when the editor is activated.
void onEditorDisable ()
 Called when the editor is deactivated.
void inspectPostApply ()
 Called after any property of the object is changed in the world editor.
U32 packUpdate (NetConnection *, U32, BitStream *)
 Instructs this object to pack its state for transfer over the network.
void unpackUpdate (NetConnection *, BitStream *)
 Instructs this object to read state data previously packed with packUpdate.
 DECLARE_CONOBJECT (fxRenderObject)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Protected Types

enum  {
  fxRenderObjectMask = (1 << 0),
  fxRenderObjectAnother = (1 << 1)
}

Protected Attributes

S32 mLastRenderTime
TextureHandle mTextureHandle
F32 mCurrentAngle
F32 mQuadSize
F32 mQuadRotateSpeed
StringTableEntry mTextureName
ColorI mObjColor

Private Types

typedef SceneObject Parent

Member Typedef Documentation

Reimplemented from SceneObject.


Member Enumeration Documentation

anonymous enum [protected]

Enumerator:
fxRenderObjectMask 
fxRenderObjectAnother 


Constructor & Destructor Documentation

fxRenderObject::fxRenderObject (  ) 

fxRenderObject::~fxRenderObject (  ) 


Member Function Documentation

void fxRenderObject::renderObject ( SceneState state,
SceneRenderImage image 
) [virtual]

Called when the object is supposed to render itself.

Parameters:
state Current rendering state.
See also:
SceneState
Parameters:
image Image associated with this object to render.
See also:
SceneRenderImage

Reimplemented from SceneObject.

virtual bool fxRenderObject::prepRenderImage ( SceneState state,
const U32  stateKey,
const U32  startZone,
const bool  modifyBaseZoneState = false 
) [virtual]

Called when the SceneGraph is ready for the registration of RenderImages.

See also:
SceneState
Parameters:
state SceneState
stateKey State key of the current SceneState
startZone Base zone index
modifyBaseZoneState If true, the object needs to modify the zone state.

Reimplemented from SceneObject.

bool fxRenderObject::onAdd (  )  [virtual]

Called when the object is added to the sim.

Reimplemented from SceneObject.

void fxRenderObject::onRemove (  )  [virtual]

Called when the object is removed from the sim.

Reimplemented from SceneObject.

void fxRenderObject::onEditorEnable (  )  [virtual]

Called when the editor is activated.

Reimplemented from SimObject.

void fxRenderObject::onEditorDisable (  )  [virtual]

Called when the editor is deactivated.

Reimplemented from SimObject.

void fxRenderObject::inspectPostApply (  )  [virtual]

Called after any property of the object is changed in the world editor.

See also:
inspectPreApply

Reimplemented from SceneObject.

U32 fxRenderObject::packUpdate ( NetConnection conn,
U32  mask,
BitStream stream 
) [virtual]

Instructs this object to pack its state for transfer over the network.

Parameters:
conn Net connection being used
mask Mask indicating fields to transmit.
stream Bitstream to pack data to
Returns:
Any bits which were not dealt with. The value is stored by the networking system. Don't set bits you weren't passed.

Reimplemented from NetObject.

void fxRenderObject::unpackUpdate ( NetConnection conn,
BitStream stream 
) [virtual]

Instructs this object to read state data previously packed with packUpdate.

Parameters:
conn Net connection being used
stream stream to read from

Reimplemented from NetObject.

static void fxRenderObject::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from SceneObject.

fxRenderObject::DECLARE_CONOBJECT ( fxRenderObject   ) 


Field Documentation

TextureHandle fxRenderObject::mTextureHandle [protected]




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen