Torque Game Engine Documentation
TGE Version 1.5.2

fxShapeReplicator Class Reference

#include <fxShapeReplicator.h>

Inheritance diagram for fxShapeReplicator:


Public Member Functions
	fxShapeReplicator ()
	~fxShapeReplicator ()
void	StartUp (void)
void	ShowReplication (void)
void	HideReplication (void)
void	renderObject (SceneState state, SceneRenderImage image)
	Called when the object is supposed to render itself.
virtual bool	prepRenderImage (SceneState *state, 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 conn, U32 mask, BitStream stream)
	Instructs this object to pack its state for transfer over the network.
void	unpackUpdate (NetConnection conn, BitStream stream)
	Instructs this object to read state data previously packed with packUpdate.
	DECLARE_CONOBJECT (fxShapeReplicator)
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
fxShapeReplicator::tagFieldData	mFieldData
Protected Types
enum	{ ReplicationMask = (1 << 0), advancedStaticOptionsMask = ReplicationMask << 1, NextFreeMask = ReplicationMask << 2 }
Protected Member Functions
void	CreateShapes (void)
void	DestroyShapes (void)
void	RenewShapes (void)
Protected Attributes
U32	mCreationAreaAngle
bool	mClientReplicationStarted
bool	mAddedToScene
U32	mCurrentShapeCount
Vector< fxShapeReplicatedStatic * >	mReplicatedShapes
MRandomLCG	RandomGen
Private Types
typedef SceneObject	Parent
Data Structures
class	tagFieldData

Member Typedef Documentation

typedef SceneObject fxShapeReplicator::Parent [private]

Reimplemented from SceneObject.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

ReplicationMask
advancedStaticOptionsMask
NextFreeMask

Constructor & Destructor Documentation

fxShapeReplicator::fxShapeReplicator ( )

fxShapeReplicator::~fxShapeReplicator ( )

Member Function Documentation

void fxShapeReplicator::CreateShapes ( void ) [protected]

void fxShapeReplicator::DestroyShapes ( void ) [protected]

void fxShapeReplicator::RenewShapes ( void ) [protected]

void fxShapeReplicator::StartUp ( void )

void fxShapeReplicator::ShowReplication ( void )

void fxShapeReplicator::HideReplication ( void )

void fxShapeReplicator::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 fxShapeReplicator::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.