Torque3D Documentation / _generateds / SFX3DWorld

SFX3DWorld

Engine/source/T3D/sfx/sfx3DWorld.h

Manager for the 3D sound world.

More...

Public Types

enum
_Anonymous_ {  TYPEMASK = WaterObjectType       
                  | StaticShapeObjectType 
                  | StaticObjectType
}

SceneTracker

Parent 

SFXWorld< 3, SFX3DObject * >

SFXWorldType

Protected Attributes

FreeListChunker< SFX3DObject >

mChunker

Allocator for the SFX3DObject SceneObjectLinks we attach to SceneObjects.

SFXWorldType

mSFXWorld

The SFX world tracking system.

Protected Functions

bool

_isTrackableObject(SceneObject * object)

Return true if the given object qualifies for being managed by this SceneTracker.

Public Functions

SFX3DWorld()

void

debugDump()

SceneObject *

getListener()

Return the current listener object.
void

notifyChanged(SceneObject * object)

Notify the SFX world that the given object had a (potential) change in its sound-related properties.
void

registerObject(SceneObject * object)

Register a SceneObject for being tracked by this tracker.
void

setListener(SceneObject * object)

Make the given object the current listener object.
void

unregisterObject(SceneObject * object)

Unregister the given object from the tracker.
void

update()

void

updateObject(SceneObjectLink * object)

Notify the tracker that the transform state of the given scene object has changed.
Detailed Description
Manager for the 3D sound world.
Any SceneObject in the world can be made the current listener. It's ear position (if it's a ShapeBase) will then be used as the reference center for attenuating 3D sounds, traversing ambient spaces, etc.
Public Types
@199

Enumerator
TYPEMASK = WaterObjectType
| StaticShapeObjectType
| StaticObjectType
The scene object type mask used to filter out the type of objects we are interested in.
typedef SceneTracker Parent 

typedef SFXWorld< 3, SFX3DObject * > SFXWorldType 

Protected Attributes
FreeListChunker< SFX3DObject > mChunker 

Allocator for the SFX3DObject SceneObjectLinks we attach to SceneObjects.
SFXWorldType mSFXWorld 

The SFX world tracking system.
Protected Functions
_isTrackableObject(SceneObject * object)

Reimplemented from: SceneTracker
Public Functions
SFX3DWorld()

debugDump()

getListener()

Return the current listener object.
notifyChanged(SceneObject * object)

Notify the SFX world that the given object had a (potential) change in its sound-related properties.
registerObject(SceneObject * object)

Reimplemented from: SceneTracker
setListener(SceneObject * object)

Make the given object the current listener object.
unregisterObject(SceneObject * object)

Reimplemented from: SceneTracker
update()

updateObject(SceneObjectLink * object)

Reimplemented from: SceneTracker