Torque Game Engine Documentation
TGE Version 1.5.2

DecalManager Class Reference

#include <decalManager.h>

Inheritance diagram for DecalManager:

Detailed Description

Manage decals in the world.

Public Member Functions

void addDecal (const Point3F &pos, const Point3F &rot, Point3F normal, const Point3F &scale, DecalData *, U32)

void ageDecal (U32)

void findSpace ()

DecalManager ()

~DecalManager ()

void dataDeleted (DecalData *data)

void renderDecal ()

DECLARE_CONOBJECT (DecalManager)

Decal Addition

These functions allow you to add new decals to the world.

void addDecal (const Point3F &pos, const Point3F &rot, Point3F normal, const Point3F &scale, DecalData *)

void addDecal (const Point3F &pos, const Point3F &rot, Point3F normal, DecalData *)

void addDecal (const Point3F &pos, Point3F normal, DecalData *)

Static Public Member Functions

static void consoleInit ()

Register global constant variables and do other one-time initialization tasks in a subclass of ConsoleObject.

Data Fields

Vector< DecalInstance * > mFreePoolBlocks

DecalInstance * mFreePool

Static Public Attributes

static U32 smMaxNumDecals

static U32 smDecalTimeout

static bool sgThisIsSelfIlluminated

static bool sgLastWasSelfIlluminated

static const U32 csmFreePoolBlockSize

static bool smDecalsOn

Protected Member Functions

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.

DecalInstance * allocateDecalInstance ()

void freeDecalInstance (DecalInstance *)

Private Types

typedef SceneObject Parent

Private Attributes

Vector< DecalInstance * > mDecalQueue

bool mQueueDirty

Member Typedef Documentation

typedef SceneObject DecalManager::Parent [private]

Reimplemented from SceneObject.

Constructor & Destructor Documentation

DecalManager::DecalManager ( )

DecalManager::~DecalManager ( )

Member Function Documentation

void DecalManager::addDecal	(	const Point3F &	pos,
		const Point3F &	rot,
		Point3F	normal,
		const Point3F &	scale,
		DecalData *	,
		U32
	)

void DecalManager::ageDecal ( U32 )

void DecalManager::findSpace ( )

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