Torque Game Engine Documentation
TGE Version 1.5.2

volumeLight Class Reference

#include <volLight.h>

Inheritance diagram for volumeLight:


Public Member Functions
void	buildObjectBox ()
void	sgRenderX (const Point3F &near1, const Point3F &far1, const Point3F &far2, const ColorF &nearcol, const ColorF &farcol, F32 offset)
void	sgRenderY (const Point3F &near1, const Point3F &far1, const Point3F &far2, const ColorF &nearcol, const ColorF &farcol, F32 offset)
	volumeLight ()
	~volumeLight ()
void	renderObject (SceneState , SceneRenderImage )
	Called when the object is supposed to render itself.
void	renderGL (SceneState , SceneRenderImage )
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	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.
void	setLtexture (const char *name)
void	setlpDistance (F32 Dist)
void	setShootDistance (F32 Dist)
void	setXextent (F32 extent)
void	setYextent (F32 extent)
void	setSubdivideU (U32 val)
void	setSubdivideV (U32 val)
void	setfootColour (ColorF col)
void	settailColour (ColorF col)
	DECLARE_CONOBJECT (volumeLight)
Static Public Member Functions
static void	consoleInit ()
	Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject.
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
StringTableEntry	mLTextureName
F32	mlpDistance
F32	mShootDistance
F32	mXextent
F32	mYextent
U32	mSubdivideU
U32	mSubdivideV
ColorF	mfootColour
ColorF	mtailColour
Protected Types
enum	{ volLightMask = (1 << 0), volLightOther = (1 << 1) }
Protected Attributes
bool	mAddedToScene
S32	mLastRenderTime
TextureHandle	mLightHandle
Private Types
typedef sgLightObject	Parent

Member Typedef Documentation

typedef sgLightObject volumeLight::Parent [private]

Reimplemented from sgLightObject.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

volLightMask
volLightOther

Constructor & Destructor Documentation

volumeLight::volumeLight ( )

volumeLight::~volumeLight ( )

Member Function Documentation

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

Reimplemented from fxLight.

void volumeLight::sgRenderX	(	const Point3F &	near1,
		const Point3F &	far1,
		const Point3F &	far2,
		const ColorF &	nearcol,
		const ColorF &	farcol,
		F32	offset
	)

void volumeLight::sgRenderY	(	const Point3F &	near1,
		const Point3F &	far1,
		const Point3F &	far2,
		const ColorF &	nearcol,
		const ColorF &	farcol,
		F32	offset
	)

void volumeLight::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 sgLightObject.

void volumeLight::renderGL	(	SceneState *	,
		SceneRenderImage *
	)

virtual bool volumeLight::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.