Torque Game Engine Documentation
TGE Version 1.5.2

fxLight Class Reference

#include <fxLight.h>

Inheritance diagram for fxLight:


Public Member Functions
	fxLight ()
	~fxLight ()
virtual void	buildObjectBox ()
virtual void	calculateLightPosition ()
virtual SceneObject *	getAttachedObject ()
void	setEnable (bool Status)
void	setFlareBitmap (const char *Name)
void	reset (void)
bool	onNewDataBlock (GameBaseData *dptr)
	Called when a new datablock is set.
void	processTick (const Move *)
	Processes a move event and updates object state once every 32 milliseconds.
bool	prepRenderImage (SceneState *state, const U32 stateKey, const U32 startZone, const bool modifyBaseZoneState)
	Called when the SceneGraph is ready for the registration of RenderImages.
void	renderObject (SceneState state, SceneRenderImage image)
	Called when the object is supposed to render itself.
bool	onAdd ()
	Called when the object is added to the sim.
void	onRemove ()
	Called when the object is removed from the sim.
void	inspectPostApply ()
	Called after any property of the object is changed in the world editor.
void	registerLights (LightManager *lightManager, bool lightingScene)
	Called to register the object's lights, if any, with the LightManager.
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 (fxLight)
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
U32	mountPoint
MatrixF	mountTransform
bool	mEnable
F32	mIconSize
ColorF	mAnimationColour
F32	mAnimationBrightness
F32	mAnimationRadius
Point3F	mAnimationPosition
Point3F	mAnimationOffset
F32	mAnimationRotation
F32	mColourElapsedTime
F32	mBrightnessElapsedTime
F32	mRadiusElapsedTime
F32	mOffsetElapsedTime
F32	mRotationElapsedTime
F32	mColourTimeScale
F32	mBrightnessTimeScale
F32	mRadiusTimeScale
F32	mOffsetTimeScale
F32	mRotationTimeScale
U32	mRedKeysLength
U32	mGreenKeysLength
U32	mBlueKeysLength
U32	mBrightnessKeysLength
U32	mRadiusKeysLength
U32	mOffsetKeysLength
U32	mRotationKeysLength
Protected Types
enum	{ fxLightConfigChangeMask = BIT(0), fxLightAttachChange = BIT(1) }
Protected Member Functions
U32	CheckKeySyntax (StringTableEntry Key)
void	CheckAnimationKeys (void)
F32	GetLerpKey (StringTableEntry Key, U32 PosFrom, U32 PosTo, F32 ValueFrom, F32 ValueTo, F32 Lerp)
void	AnimateLight (void)
void	InitialiseAnimation (void)
void	ResetAnimation (void)
bool	TestLOS (const Point3F &ObjectPosition, SceneObject *AttachedObj)
Protected Attributes
bool	mAddedToScene
MRandomLCG	RandomGen
TextureHandle	mIconTextureHandle
TextureHandle	mFlareTextureHandle
LightInfo	mLight
U32	mLastAnimateTime
U32	mLastRenderTime
F32	mFlareScale
bool	mAttached
Private Types
typedef GameBase	Parent
Private Attributes
fxLightData *	mDataBlock

Member Typedef Documentation

typedef GameBase fxLight::Parent [private]

Reimplemented from GameBase.

Reimplemented in sgLightObject, and volumeLight.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

fxLightConfigChangeMask
fxLightAttachChange

Constructor & Destructor Documentation

fxLight::fxLight ( )

fxLight::~fxLight ( )

Member Function Documentation

U32 fxLight::CheckKeySyntax ( StringTableEntry Key ) [protected]

void fxLight::CheckAnimationKeys ( void ) [protected]

F32 fxLight::GetLerpKey	(	StringTableEntry	Key,
		U32	PosFrom,
		U32	PosTo,
		F32	ValueFrom,
		F32	ValueTo,
		F32	Lerp
	)			`[protected]`

void fxLight::AnimateLight ( void ) [protected]

void fxLight::InitialiseAnimation ( void ) [protected]

void fxLight::ResetAnimation ( void ) [protected]

bool fxLight::TestLOS	(	const Point3F &	ObjectPosition,
		SceneObject *	AttachedObj
	)			`[protected]`

virtual void fxLight::buildObjectBox ( ) [inline, virtual]

Reimplemented in volumeLight.

virtual void fxLight::calculateLightPosition ( ) [inline, virtual]

Reimplemented in sgLightObject.

virtual SceneObject* fxLight::getAttachedObject ( ) [inline, virtual]

Reimplemented in sgLightObject.

void fxLight::setEnable ( bool Status )

void fxLight::setFlareBitmap ( const char * Name )

void fxLight::reset ( void )

bool fxLight::onNewDataBlock ( GameBaseData * dptr ) [virtual]

Called when a new datablock is set.

This allows subclasses to appropriately handle new datablocks.

See also:: setDataBlock()

Parameters:

dptr

New datablock

Reimplemented from GameBase.

Reimplemented in sgLightObject.

void fxLight::processTick ( const Move * move ) [virtual]

Processes a move event and updates object state once every 32 milliseconds.

This takes place both on the client and server, every 32 milliseconds (1 tick).

See also:: ProcessList

Parameters:

move

Move event corresponding to this tick, or NULL.

Reimplemented from GameBase.

Reimplemented in sgLightObject.

bool fxLight::prepRenderImage	(	SceneState *	state,
		const U32	stateKey,
		const U32	startZone,
		const bool	modifyBaseZoneState
	)			`[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.