Torque3D Documentation / _generateds / SceneSpace

SceneSpace

Engine/source/scene/sceneSpace.h

Abstract base class for SceneObjects that define subspaces in a scene.

More...

Protected Types

enum
_Anonymous_ {
  TransformMask = Parent::NextFreeMask << 0
  NextFreeMask = Parent::NextFreeMask << 1
}

Public Types

SceneObject

Parent

Protected Attributes

BaseMatInstance *

mEditorRenderMaterial

Protected Functions

BaseMatInstance *

_createEditorRenderMaterial()

ColorI

_getDefaultEditorSolidColor()

ColorI

_getDefaultEditorWireframeColor()

void

_renderObject(ObjectRenderInst * ri, SceneRenderState * state, BaseMatInstance * overrideMat)

Render a visualization of the volume.

Public Functions

SceneSpace()

~SceneSpace()

bool

onAdd()

Called when the object is added to the sim.
void

onEditorDisable()

Called when the editor is deactivated.
void

onEditorEnable()

Called when the editor is activated.
void

onRemove()

Called when the object is removed from the sim.
U32

packUpdate(NetConnection * conn, U32 mask, BitStream * stream)

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

prepRenderImage(SceneRenderState * state)

Called when the SceneManager is ready for the registration of render instances.
void

setTransform(const MatrixF & mat)

Sets the Object -> World transform.
void

unpackUpdate(NetConnection * conn, BitStream * stream)

Instructs this object to read state data previously packed with packUpdate.
Detailed Description
Abstract base class for SceneObjects that define subspaces in a scene.
Use SceneObject::containsPoint to find out whether a given space contains a particular point.
Protected Types
@158

Enumerator
TransformMask = Parent::NextFreeMask << 0
Object transform has changed.
NextFreeMask = Parent::NextFreeMask << 1
Public Types
typedef SceneObject Parent 

Protected Attributes
BaseMatInstance * mEditorRenderMaterial 

Protected Functions
_createEditorRenderMaterial()

_getDefaultEditorSolidColor()

Reimplemented by: Portal, SFXSpace, Zone
_getDefaultEditorWireframeColor()

Reimplemented by: Portal
_renderObject(ObjectRenderInst * ri, SceneRenderState * state, BaseMatInstance * overrideMat)

Render a visualization of the volume.
Reimplemented by: ScenePolyhedralObject, ScenePolyhedralObject, AccumulationVolume, OcclusionVolume, Portal
Public Functions
SceneSpace()

~SceneSpace()

onAdd()

Reimplemented from: SceneObject
Reimplemented by: ScenePolyhedralObject, ScenePolyhedralObject, ScenePolyhedralZone, SceneRootZone, AccumulationVolume, OcclusionVolume
onEditorDisable()

Reimplemented from: SimObject
onEditorEnable()

Reimplemented from: SimObject
onRemove()

Reimplemented from: SceneObject
Reimplemented by: SceneRootZone, AccumulationVolume
packUpdate(NetConnection * conn, U32 mask, BitStream * stream)

Reimplemented from: SceneObject
Reimplemented by: AccumulationVolume, SceneSimpleZone, Portal, SceneAmbientSoundObject, SceneAmbientSoundObject, ScenePolyhedralObject, ScenePolyhedralObject, SceneZoneSpace
prepRenderImage(SceneRenderState * state)

Reimplemented from: SceneObject
Reimplemented by: SceneSimpleZone
setTransform(const MatrixF & mat)

Reimplemented from: SceneObject
Reimplemented by: ScenePolyhedralZone, SceneSimpleZone, AccumulationVolume, OcclusionVolume, Portal
unpackUpdate(NetConnection * conn, BitStream * stream)

Reimplemented from: SceneObject
Reimplemented by: AccumulationVolume, SceneSimpleZone, Portal, SceneAmbientSoundObject, SceneAmbientSoundObject, ScenePolyhedralObject, ScenePolyhedralObject, SceneZoneSpace