Torque Game Engine Documentation
TGE Version 1.5.2

TSStatic Class Reference

#include <tsStatic.h>

Inheritance diagram for TSStatic:


Public Member Functions
	TSStatic ()
	~TSStatic ()
	DECLARE_CONOBJECT (TSStatic)
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.
void	inspectPostApply ()
	Called after any property of the object is changed in the world editor.
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Protected Member Functions
bool	onAdd ()
	Called when the object is added to the sim.
void	onRemove ()
	Called when the object is removed from the sim.
bool	castRay (const Point3F &start, const Point3F &end, RayInfo *info)
	Casts a ray and obtain collision information, returns true if RayInfo is modified.
bool	buildPolyList (AbstractPolyList *polyList, const Box3F &box, const SphereF &sphere)
	Builds a list of polygons which intersect a bounding volume.
void	buildConvex (const Box3F &box, Convex *convex)
	Builds a convex hull for this object.
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.
void	renderObject (SceneState state, SceneRenderImage image)
	Called when the object is supposed to render itself.
void	setTransform (const MatrixF &mat)
	Sets the Object -> World transform.
Protected Attributes
Convex *	mConvexList
StringTableEntry	mShapeName
U32	mShapeHash
Resource< TSShape >	mShape
TSShapeInstance *	mShapeInstance
Shadow *	mShadow
Vector< S32 >	mCollisionDetails
Vector< S32 >	mLOSDetails
Private Types
enum	Constants { MaxCollisionShapes = 8 }
enum	MaskBits { advancedStaticOptionsMask = Parent::NextFreeMask, NextFreeMask = Parent::NextFreeMask << 1 }
typedef SceneObject	Parent
Static Private Attributes
static U32	smUniqueIdentifier
Friends
class	TSStaticConvex

Member Typedef Documentation

typedef SceneObject TSStatic::Parent [private]

Reimplemented from SceneObject.

Reimplemented in fxShapeReplicatedStatic.

Member Enumeration Documentation

enum TSStatic::Constants [private]

Enumerator:

MaxCollisionShapes

enum TSStatic::MaskBits [private]

Enumerator:

advancedStaticOptionsMask
NextFreeMask

Constructor & Destructor Documentation

TSStatic::TSStatic ( )

TSStatic::~TSStatic ( )

Member Function Documentation

bool TSStatic::onAdd ( ) [protected, virtual]

Called when the object is added to the sim.

Reimplemented from SceneObject.

void TSStatic::onRemove ( ) [protected, virtual]

Called when the object is removed from the sim.

Reimplemented from SceneObject.

bool TSStatic::castRay	(	const Point3F &	start,
		const Point3F &	end,
		RayInfo *	info
	)			`[protected, virtual]`

Casts a ray and obtain collision information, returns true if RayInfo is modified.

Parameters:

	start	Start point of ray
	end	End point of ray
	info	Collision information obtained (out)

Reimplemented from SceneObject.

bool TSStatic::buildPolyList	(	AbstractPolyList *	polyList,
		const Box3F &	box,
		const SphereF &	sphere
	)			`[protected, virtual]`

Builds a list of polygons which intersect a bounding volume.

This will use either the sphere or the box, not both, the SceneObject implimentation ignores sphere.

See also:: AbstractPolyList

Parameters:

	polyList	Poly list build (out)
	box	Box bounding volume
	sphere	Sphere bounding volume

Reimplemented from SceneObject.

void TSStatic::buildConvex	(	const Box3F &	box,
		Convex *	convex
	)			`[protected, virtual]`

Builds a convex hull for this object.

Think of a convex hull as a low-res mesh which covers, as tightly as possible, the object mesh, and is used as a collision mesh.

Parameters:

	box
	convex	Convex mesh generated (out)

Reimplemented from SceneObject.

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