Torque Game Engine Documentation
TGE Version 1.5.2

InteriorMap Class Reference

#include <interiorMap.h>

Inheritance diagram for InteriorMap:


Public Types
enum	{ TexShaded = 0, SolidShaded, TexWireframe, SolidWireframe, Edges, BrushColors, FaceColors, BspPolys, CollisionHulls, Lighting, TexLighting }
typedef SceneObject	Parent
Public Member Functions
	DECLARE_CONOBJECT (InteriorMap)
InteriorMapResource::Entity *	getEntity (char *classname)
void	getEntities (char classname, VectorPtr< InteriorMapResource::Entity > ents)
	InteriorMap (void)
virtual	~InteriorMap (void)
bool	setPath (const char *filename)
bool	loadTextures ()
bool	calcTexgenDiv ()
void	renderObject (SceneState , SceneRenderImage )
	Called when the object is supposed to render itself.
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	onEditorEnable ()
	Called when the editor is activated.
void	onEditorDisable ()
	Called when the editor is deactivated.
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.
bool	castRay (const Point3F &, const Point3F &, RayInfo *)
	Casts a ray and obtain collision information, returns true if RayInfo is modified.
void	buildConvex (const Box3F &box, Convex *convex)
	Builds a convex hull for this object.
void	removeBrush (S32 brushIndex)
S32	getTextureCount ()
const char *	getTextureName (S32 index)
const char *	getTexturePathway ()
Point2I	getTextureSize (S32 index)
S32	getBrushIndex (U32 brushID)
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
TextureHandle *	mTexHandles
TextureHandle *	mWhite
StringTableEntry	mFileName
StringTableEntry	mFilePath
StringTableEntry	mTexPath
U32	mRenderMode
bool	mEnableLights
Resource< InteriorMapResource >	mInteriorRes
Protected Types
enum	{ MoveMask = (1 << 0), RenderModeMask = (1 << 1) }
Protected Member Functions
bool	render (void)
Protected Attributes
bool	mLoaded
Convex *	mConvexList
Friends
class	InteriorMapConvex

Member Typedef Documentation

typedef SceneObject InteriorMap::Parent

Reimplemented from SceneObject.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

MoveMask
RenderModeMask

anonymous enum

Enumerator:

TexShaded
SolidShaded
TexWireframe
SolidWireframe
Edges
BrushColors
FaceColors
BspPolys
CollisionHulls
Lighting
TexLighting

Constructor & Destructor Documentation

InteriorMap::InteriorMap ( void )

virtual InteriorMap::~InteriorMap ( void ) [virtual]

Member Function Documentation

InteriorMap::DECLARE_CONOBJECT ( InteriorMap )

InteriorMapResource::Entity* InteriorMap::getEntity ( char * classname ) [inline]

void InteriorMap::getEntities	(	char *	classname,
		VectorPtr< InteriorMapResource::Entity * >	ents
	)			`[inline]`

bool InteriorMap::render ( void ) [protected]

bool InteriorMap::setPath ( const char * filename )

bool InteriorMap::loadTextures ( )

bool InteriorMap::calcTexgenDiv ( )

void InteriorMap::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 SceneObject.

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

Reimplemented from SceneObject.

bool InteriorMap::onAdd ( ) [virtual]

Called when the object is added to the sim.

Reimplemented from SceneObject.

void InteriorMap::onRemove ( ) [virtual]

Called when the object is removed from the sim.

Reimplemented from SceneObject.

void InteriorMap::onEditorEnable ( ) [virtual]

Called when the editor is activated.

Reimplemented from SimObject.

void InteriorMap::onEditorDisable ( ) [virtual]

Called when the editor is deactivated.

Reimplemented from SimObject.

void InteriorMap::inspectPostApply ( ) [virtual]

Called after any property of the object is changed in the world editor.

See also:: inspectPreApply

Reimplemented from SceneObject.

U32 InteriorMap::packUpdate	(	NetConnection *	conn,
		U32	mask,
		BitStream *	stream
	)			`[virtual]`

Instructs this object to pack its state for transfer over the network.

Parameters:

	conn	Net connection being used
	mask	Mask indicating fields to transmit.
	stream	Bitstream to pack data to

Returns:: Any bits which were not dealt with. The value is stored by the networking system. Don't set bits you weren't passed.

Reimplemented from NetObject.

void InteriorMap::unpackUpdate	(	NetConnection *	conn,
		BitStream *	stream
	)			`[virtual]`

Instructs this object to read state data previously packed with packUpdate.

Parameters:

	conn	Net connection being used
	stream	stream to read from

Reimplemented from NetObject.

static void InteriorMap::initPersistFields ( ) [static]

See also:: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from SceneObject.

bool InteriorMap::castRay	(	const Point3F &	start,
		const Point3F &	end,
		RayInfo *	info
	)			`[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.

void InteriorMap::buildConvex	(	const Box3F &	box,
		Convex *	convex
	)			`[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.

void InteriorMap::removeBrush ( S32 brushIndex )

S32 InteriorMap::getTextureCount ( )

const char* InteriorMap::getTextureName ( S32 index )

const char* InteriorMap::getTexturePathway ( )

Point2I InteriorMap::getTextureSize ( S32 index )

S32 InteriorMap::getBrushIndex ( U32 brushID )

Friends And Related Function Documentation

friend class InteriorMapConvex [friend]

Field Documentation

bool InteriorMap::mLoaded [protected]

TextureHandle* InteriorMap::mTexHandles

TextureHandle* InteriorMap::mWhite

StringTableEntry InteriorMap::mFileName

StringTableEntry InteriorMap::mFilePath

StringTableEntry InteriorMap::mTexPath

U32 InteriorMap::mRenderMode

bool InteriorMap::mEnableLights

Resource<InteriorMapResource> InteriorMap::mInteriorRes

Convex* InteriorMap::mConvexList [protected]

InteriorMap Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Protected Types

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation