SFXObject
Information about an object in the SFX world.
Implementor Interface
The following methods must be implemented by the client.
They are defined here just for reference. If you don't override them, you'll get link errors.
getReferenceCenter(F32 pos)
Return the world-space position of the ears on this object.
getRealBounds(F32 minBounds, F32 maxBounds)
Return the object's bounding box in world-space excluding its surround zone.
bool
containsPoint(const F32 point)
Return true if the given point is contained in the object's volume.
Return the ambient space active within this object.
Public Types
ScopeTrackerObject< NUM_DIMENSIONS >
Parent
Public Functions
clearFlags(U32 bits)
bool
bool
Return true if this object is currently being used as the listener.
bool
Return true if this object is occluding sound.
bool
Return true if this object is only a sound occluder without any more ambient sound properties.
bool
isPortal()
Return true if this object connects two ambient spaces.
bool
isZone()
Detailed Description
Information about an object in the SFX world.
SFXObjects are:
Occluders: blocking sound
Zones: ambient sound spaces
Portals: connectors between zones
Listeners: receiving sound
Note that emitters are not managed by the SFX world. Instead, the set of 3D voices active on the device at any one point is defined as the set of current sound sources.
Implementor Interface
The following methods must be implemented by the client.
They are defined here just for reference. If you don't override them, you'll get link errors.
getReferenceCenter(F32 pos)
Return the world-space position of the ears on this object.
This will only be called on objects that are made listeners.
getBounds(F32 minBounds, F32 maxBounds)
Return the object's bounding box in world-space including its surround zone.
getRealBounds(F32 minBounds, F32 maxBounds)
Return the object's bounding box in world-space excluding its surround zone.
containsPoint(const F32 point)
Return true if the given point is contained in the object's volume.
getAmbience()
Return the ambient space active within this object.
note:Portals cannot have their own ambient spaces.
describeSelf()
Public Types
typedef ScopeTrackerObject< NUM_DIMENSIONS > Parent
Protected Attributes
BitSet32 mFlags
Public Functions
SFXObject()
clearFlags(U32 bits)
isEmitter()
isListener()
Return true if this object is currently being used as the listener.
note:All other sound-related properties (occlusion, ambience, etc.) will be ignored on the listener object.
isOccluder()
Return true if this object is occluding sound.
isOccluderOnly()
Return true if this object is only a sound occluder without any more ambient sound properties.
These kind of objects are not put into the tracking system.
isPortal()
Return true if this object connects two ambient spaces.
isZone()
setFlags(U32 bits)