Torque Game Engine Documentation
TGE Version 1.5.2

MirrorSubObject Class Reference

#include <mirrorSubObject.h>

Inheritance diagram for MirrorSubObject:


Public Member Functions
	MirrorSubObject ()
	~MirrorSubObject ()
	DECLARE_CONOBJECT (MirrorSubObject)
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
U32	mDetailLevel
U32	mZone
F32	mAlphaLevel
Point3F	mCentroid
U32	surfaceCount
U32	surfaceStart
Protected Member Functions
U32	getSubObjectKey () const
bool	_readISO (Stream &)
bool	_writeISO (Stream &) const
SubObjectRenderImage *	getRenderImage (SceneState *state, const Point3F &)
bool	renderDetailDependant () const
U32	getZone () const
void	noteTransformChange ()
InteriorSubObject *	clone (InteriorInstance *) const
void	renderObject (SceneState state, SceneRenderImage image)
	Called when the object is supposed to render itself.
void	transformModelview (const U32 portalIndex, const MatrixF &oldMV, MatrixF *newMV)
	This is used by a portal controling object to transform the base-modelview used by the scenegraph for rendering to the modelview it needs to render correctly.
void	transformPosition (const U32 portalIndex, Point3F &point)
	Used to tranform the position of a point based on a portal.
bool	computeNewFrustum (const U32 portalIndex, const F64 oldFrustum, const F64 nearPlane, const F64 farPlane, const RectI &oldViewport, F64 newFrustum, RectI &newViewport, const bool flippedMatrix)
	Returns a new view frustum for the portal.
void	openPortal (const U32 portalIndex, SceneState pCurrState, SceneState pParentState)
	Called before things are to be rendered from the portals point of view, to set up everything the portal needs to render correctly.
void	closePortal (const U32 portalIndex, SceneState pCurrState, SceneState pParentState)
	Called after rendering of a portal is complete, this resets the states the previous call to openPortal() changed.
void	getWSPortalPlane (const U32 portalIndex, PlaneF *plane)
	Returns the plane of the portal in world space.
Private Types
typedef InteriorSubObject	Parent
Private Member Functions
bool	isInitialized () const
void	setupTransforms ()
Private Attributes
bool	mInitialized
TextureHandle *	mWhite
MatrixF	mReflectionMatrix

Member Typedef Documentation

typedef InteriorSubObject MirrorSubObject::Parent [private]

Reimplemented from InteriorSubObject.

Constructor & Destructor Documentation

MirrorSubObject::MirrorSubObject ( )

MirrorSubObject::~MirrorSubObject ( )

Member Function Documentation

bool MirrorSubObject::isInitialized ( ) const [inline, private]

void MirrorSubObject::setupTransforms ( ) [private]

U32 MirrorSubObject::getSubObjectKey ( ) const [protected, virtual]

Implements InteriorSubObject.

bool MirrorSubObject::_readISO ( Stream & ) [protected, virtual]

Reimplemented from InteriorSubObject.

bool MirrorSubObject::_writeISO ( Stream & ) const [protected, virtual]

Reimplemented from InteriorSubObject.

SubObjectRenderImage* MirrorSubObject::getRenderImage	(	SceneState *	state,
		const Point3F &
	)			`[protected, virtual]`

Implements InteriorSubObject.

bool MirrorSubObject::renderDetailDependant ( ) const [protected, virtual]

Implements InteriorSubObject.

U32 MirrorSubObject::getZone ( ) const [protected, virtual]

Implements InteriorSubObject.

void MirrorSubObject::noteTransformChange ( ) [protected, virtual]

Reimplemented from InteriorSubObject.

InteriorSubObject* MirrorSubObject::clone ( InteriorInstance * ) const [protected, virtual]

Implements InteriorSubObject.

void MirrorSubObject::renderObject	(	SceneState *	state,
		SceneRenderImage *	image
	)			`[protected, 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.

void MirrorSubObject::transformModelview	(	const U32	portalIndex,
		const MatrixF &	oldMV,
		MatrixF *	newMV
	)			`[protected, virtual]`

This is used by a portal controling object to transform the base-modelview used by the scenegraph for rendering to the modelview it needs to render correctly.

See also:: MirrorSubObject

Parameters:

	portalIndex	Index of portal in the list of portals controlled by the object.
	oldMV	Current modelview matrix used by the SceneGraph (in)
	newMV	New modelview to be used by the SceneGraph (out)

Reimplemented from SceneObject.

void MirrorSubObject::transformPosition	(	const U32	portalIndex,
		Point3F &	point
	)			`[protected, virtual]`

Used to tranform the position of a point based on a portal.

Parameters:

	portalIndex	Index of a portal to transform by.
	point	Point to transform.

Reimplemented from SceneObject.

bool MirrorSubObject::computeNewFrustum	(	const U32	portalIndex,
		const F64 *	oldFrustum,
		const F64	nearPlane,
		const F64	farPlane,
		const RectI &	oldViewport,
		F64 *	newFrustum,
		RectI &	newViewport,
		const bool	flippedMatrix
	)			`[protected, virtual]`

Returns a new view frustum for the portal.

Parameters:

	portalIndex	Which portal in the list of portals the object controls
	oldFrustum	Current frustum.
	nearPlane	Near clipping plane.
	farPlane	Far clipping plane.
	oldViewport	Current viewport.
	newFrustum	New view frustum to use. (out)
	newViewport	New viewport to use. (out)
	flippedMatrix	Should the object should use a flipped matrix to calculate viewport and frustum?

Reimplemented from SceneObject.

void MirrorSubObject::openPortal	(	const U32	portalIndex,
		SceneState *	pCurrState,
		SceneState *	pParentState
	)			`[protected, virtual]`

Called before things are to be rendered from the portals point of view, to set up everything the portal needs to render correctly.

Parameters:

	portalIndex	Index of portal to use.
	pCurrState	Current SceneState
	pParentState	SceneState used before this portal was activated

Reimplemented from SceneObject.

void MirrorSubObject::closePortal	(	const U32	portalIndex,
		SceneState *	pCurrState,
		SceneState *	pParentState
	)			`[protected, virtual]`

Called after rendering of a portal is complete, this resets the states the previous call to openPortal() changed.

Parameters:

	portalIndex	Index of portal to use.
	pCurrState	Current SceneState
	pParentState	SceneState used before this portal was activated

Reimplemented from SceneObject.

void MirrorSubObject::getWSPortalPlane	(	const U32	portalIndex,
		PlaneF *	plane
	)			`[protected, virtual]`

Returns the plane of the portal in world space.

Parameters:

	portalIndex	Index of portal to use.
	plane	Plane of the portal in world space (out)

Reimplemented from SceneObject.

MirrorSubObject::DECLARE_CONOBJECT ( MirrorSubObject )

static void MirrorSubObject::initPersistFields ( ) [static]

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

Reimplemented from SceneObject.

Field Documentation

U32 MirrorSubObject::mDetailLevel

U32 MirrorSubObject::mZone

F32 MirrorSubObject::mAlphaLevel

Point3F MirrorSubObject::mCentroid

U32 MirrorSubObject::surfaceCount

U32 MirrorSubObject::surfaceStart

bool MirrorSubObject::mInitialized [private]

TextureHandle* MirrorSubObject::mWhite [private]

MatrixF MirrorSubObject::mReflectionMatrix [private]

MirrorSubObject Class Reference

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation