Torque Game Engine Documentation
TGE Version 1.5.2

SceneGraph Class Reference

#include <sceneGraph.h>

Public Member Functions

SceneGraph (bool isClient)

~SceneGraph ()

U32 getStateKey () const

LightManager * getLightManager ()

Sky * getCurrentSky ()

TerrainBlock * getCurrentTerrain ()

DecalManager * getCurrentDecalManager ()

void getWaterObjectList (SimpleQueryList &)

TextureHandle getFogTexture ()

TextureHandle getFogTextureIntensity ()

void findZone (const Point3F &, SceneObject *&, U32 &)

SceneObject Management

bool addObjectToScene (SceneObject *)

void removeObjectFromScene (SceneObject *)

void zoneInsert (SceneObject *)

void zoneRemove (SceneObject *)

Zone management

void registerZones (SceneObject *, U32 numZones)

void unregisterZones (SceneObject *)

SceneObject * getZoneOwner (const U32 zone)

Rendering and Scope Management

void renderScene (const U32 objectMask=0xffffffff)

void scopeScene (const Point3F &scopePosition, const F32 scopeDistance, NetConnection *netConnection)

Camera

For objects, valid only during the rendering cycle

const Point3F & getBaseCameraPosition () const

const Point3F & getCurrCameraPosition () const

Fog/Visibility Management

ColorF getFogColor () const

F32 getFogDistance () const

F32 getVisibleDistance () const

F32 getFogDistanceMod () const

F32 getVisibleDistanceMod () const

void setFogDistance (F32 dist)

void setVisibleDistance (F32 dist)

void setFogColor (ColorF fogColor)

void setFogVolumes (U32 numFogVolumes, FogVolume *fogVolumes)

void getFogVolumes (U32 &numFogVolumes, FogVolume *&fogVolumes)

void buildFogTexture (SceneState *pState)

void buildFogTextureSpecial (SceneState *pState)

void getFogCoordData (F32 &invVisibleDistance, F32 &heightOffset, F32 &invHeightRange) const

void getFogCoordPair (F32 dist, F32 z, F32 &x, F32 &y) const

F32 getFogCoord (F32 dist, F32 z) const

Static Public Attributes

static F32 smVisibleDistanceMod

static bool useSpecial

Protected Member Functions

void addRefPoolBlock ()

SceneObjectRef * allocateObjectRef ()

void freeObjectRef (SceneObjectRef *)

void buildSceneTree (SceneState *, SceneObject *, const U32, const U32, const U32)

void traverseSceneTree (SceneState *pState)

void treeTraverseVisit (SceneObject *, SceneState *, const U32)

void compactZonesCheck ()

bool alreadyManagingZones (SceneObject *) const

void rezoneObject (SceneObject *)

void addToWaterList (SceneObject *obj)

void removeFromWaterList (SceneObject *obj)

Protected Attributes

TextureHandle mFogTexture

TextureHandle mFogTextureIntensity

bool mIsClient

bool mHazeArrayDirty

F32 mInvVisibleDistance

F32 mHeightRangeBase

F32 mHeightOffset

F32 mInvHeightRange

U32 mCurrZoneEnd

U32 mNumActiveZones

Point3F mBaseCameraPosition

Point3F mCurrCameraPosition

U32 mNumFogVolumes

FogVolume mFogVolumes [MaxFogVolumes]

F32 mFogDistance

F32 mVisibleDistance

ColorF mFogColor

LightManager mLightManager

Sky * mCurrSky

TerrainBlock * mCurrTerrain

DecalManager * mCurrDecalManager

Vector< SceneObject * > mWaterList

SceneObjectRef * mFreeRefPool

Vector< SceneObjectRef * > mRefPoolBlocks

Vector< ZoneManager > mZoneManagers

Vector< SceneObjectRef * > mZoneLists

Zone Lists.

Static Protected Attributes

static const U32 csmMaxTraversalDepth

static U32 smStateKey

static F32 mHazeArray [FogTextureDistSize]

static U32 mHazeArrayi [FogTextureDistSize]

static F32 mDistArray [FogTextureDistSize]

static const U32 csmRefPoolBlockSize

Private Member Functions

void setBaseCameraPosition (const Point3F &)

void setCurrCameraPosition (const Point3F &)

Data Structures

struct ZoneManager

Constructor & Destructor Documentation

SceneGraph::SceneGraph ( bool isClient )

SceneGraph::~SceneGraph ( )

Member Function Documentation

bool SceneGraph::addObjectToScene ( SceneObject * )

void SceneGraph::removeObjectFromScene ( SceneObject * )

void SceneGraph::zoneInsert ( SceneObject * )

void SceneGraph::zoneRemove ( SceneObject * )

void SceneGraph::registerZones	(	SceneObject *	,
		U32	numZones
	)

void SceneGraph::unregisterZones ( SceneObject * )

SceneObject * SceneGraph::getZoneOwner ( const U32 zone ) [inline]

void SceneGraph::renderScene ( const U32 objectMask = 0xffffffff )

void SceneGraph::scopeScene	(	const Point3F &	scopePosition,
		const F32	scopeDistance,
		NetConnection *	netConnection
	)

const Point3F & SceneGraph::getBaseCameraPosition ( ) const [inline]

const Point3F & SceneGraph::getCurrCameraPosition ( ) const [inline]

ColorF SceneGraph::getFogColor ( ) const [inline]

F32 SceneGraph::getFogDistance ( ) const [inline]

F32 SceneGraph::getVisibleDistance ( ) const [inline]

F32 SceneGraph::getFogDistanceMod ( ) const [inline]

F32 SceneGraph::getVisibleDistanceMod ( ) const [inline]

void SceneGraph::setFogDistance ( F32 dist )

void SceneGraph::setVisibleDistance ( F32 dist )

void SceneGraph::setFogColor ( ColorF fogColor )

void SceneGraph::setFogVolumes	(	U32	numFogVolumes,
		FogVolume *	fogVolumes
	)

void SceneGraph::getFogVolumes	(	U32 &	numFogVolumes,
		FogVolume *&	fogVolumes
	)			`[inline]`

void SceneGraph::buildFogTexture ( SceneState * pState )

void SceneGraph::buildFogTextureSpecial ( SceneState * pState )

void SceneGraph::getFogCoordData	(	F32 &	invVisibleDistance,
		F32 &	heightOffset,
		F32 &	invHeightRange
	)			const `[inline]`

void SceneGraph::getFogCoordPair	(	F32	dist,
		F32	z,
		F32 &	x,
		F32 &	y
	)			const `[inline]`

F32 SceneGraph::getFogCoord	(	F32	dist,
		F32	z
	)			const `[inline]`

U32 SceneGraph::getStateKey ( ) const [inline]

void SceneGraph::setBaseCameraPosition ( const Point3F & ) [inline, private]

void SceneGraph::setCurrCameraPosition ( const Point3F & ) [inline, private]

void SceneGraph::addRefPoolBlock ( ) [protected]

SceneObjectRef * SceneGraph::allocateObjectRef ( ) [inline, protected]

void SceneGraph::freeObjectRef ( SceneObjectRef * ) [inline, protected]

LightManager * SceneGraph::getLightManager ( ) [inline]

Sky* SceneGraph::getCurrentSky ( ) [inline]

TerrainBlock* SceneGraph::getCurrentTerrain ( ) [inline]

DecalManager* SceneGraph::getCurrentDecalManager ( ) [inline]

void SceneGraph::getWaterObjectList ( SimpleQueryList & )

TextureHandle SceneGraph::getFogTexture ( ) [inline]

TextureHandle SceneGraph::getFogTextureIntensity ( ) [inline]

void SceneGraph::buildSceneTree	(	SceneState *	,
		SceneObject *	,
		const	U32,
		const	U32,
		const	U32
	)			`[protected]`

void SceneGraph::traverseSceneTree ( SceneState * pState ) [protected]

void SceneGraph::treeTraverseVisit	(	SceneObject *	,
		SceneState *	,
		const	U32
	)			`[protected]`

void SceneGraph::compactZonesCheck ( ) [protected]

bool SceneGraph::alreadyManagingZones ( SceneObject * ) const [protected]

void SceneGraph::findZone	(	const Point3F &	,
		SceneObject *&	,
		U32 &
	)

void SceneGraph::rezoneObject ( SceneObject * ) [protected]

void SceneGraph::addToWaterList ( SceneObject * obj ) [protected]

void SceneGraph::removeFromWaterList ( SceneObject * obj ) [protected]

Field Documentation

TextureHandle SceneGraph::mFogTexture [protected]

TextureHandle SceneGraph::mFogTextureIntensity [protected]

const U32 SceneGraph::csmMaxTraversalDepth [static, protected]

U32 SceneGraph::smStateKey [static, protected]

F32 SceneGraph::smVisibleDistanceMod [static]

bool SceneGraph::useSpecial [static]

bool SceneGraph::mIsClient [protected]

bool SceneGraph::mHazeArrayDirty [protected]

F32 SceneGraph::mHazeArray[FogTextureDistSize] [static, protected]

U32 SceneGraph::mHazeArrayi[FogTextureDistSize] [static, protected]

F32 SceneGraph::mDistArray[FogTextureDistSize] [static, protected]

F32 SceneGraph::mInvVisibleDistance [protected]

F32 SceneGraph::mHeightRangeBase [protected]

F32 SceneGraph::mHeightOffset [protected]

F32 SceneGraph::mInvHeightRange [protected]

U32 SceneGraph::mCurrZoneEnd [protected]

U32 SceneGraph::mNumActiveZones [protected]

Point3F SceneGraph::mBaseCameraPosition [protected]

Point3F SceneGraph::mCurrCameraPosition [protected]

U32 SceneGraph::mNumFogVolumes [protected]

FogVolume SceneGraph::mFogVolumes[MaxFogVolumes] [protected]

F32 SceneGraph::mFogDistance [protected]

F32 SceneGraph::mVisibleDistance [protected]

ColorF SceneGraph::mFogColor [protected]

LightManager SceneGraph::mLightManager [protected]

Sky* SceneGraph::mCurrSky [protected]

TerrainBlock* SceneGraph::mCurrTerrain [protected]

DecalManager* SceneGraph::mCurrDecalManager [protected]

Vector<SceneObject*> SceneGraph::mWaterList [protected]

SceneObjectRef* SceneGraph::mFreeRefPool [protected]

Vector<SceneObjectRef*> SceneGraph::mRefPoolBlocks [protected]

const U32 SceneGraph::csmRefPoolBlockSize [static, protected]

Vector<ZoneManager> SceneGraph::mZoneManagers [protected]

Vector<SceneObjectRef*> SceneGraph::mZoneLists [protected]

Zone Lists.

Note:: The object refs in this are somewhat singular in that the object pointer does not point to a referenced object, but the owner of that zone...