Torque Game Engine Documentation CVS Revision Label 1.3.x

Torque Home   Class Hierarchy   Data Structures   Namespaces   Namespace Members   File List   Globals

AudioEmitter Class Reference #include <audioEmitter.h> Inheritance diagram for AudioEmitter: Public Types enum   UpdateMasks {   InitialUpdateMask = BIT(0),   TransformUpdateMask = BIT(1),   DirtyUpdateMask = BIT(2) } Public Member Functions   AudioEmitter (bool client=false) void  processLoopEvent () bool  update () void  packData (NetConnection *conn, U32 mask, BitStream *stream) void  unpackData (NetConnection *conn, BitStream *stream) void  setTransform (const MatrixF &mat)   Sets the Object -> World transform. void  setScale (const VectorF &scale)   Sets the scale for the object. void  inspectPreApply ()   Called before any property of the object is changed in the world editor. void  inspectPostApply ()   Called after any property of the object is changed in the world editor. bool  prepRenderImage (SceneState *state, const U32 stateKey, const U32 startZone, const bool modifyBaseZoneState)   Called when the SceneGraph is ready for the registration of RenderImages. void  renderObject (SceneState *state, SceneRenderImage *image)   Called when the object is supposed to render itself. void  render3DVisualFeedBack (void) U32  packUpdate (NetConnection *conn, U32 mask, BitStream *stream)   Instructs this object to pack its state for transfer over the network. void  unpackUpdate (NetConnection *conn, BitStream *stream)   Instructs this object to read state data previously packed with packUpdate. bool  onAdd ()   Called when the object is added to the sim. void  onRemove ()   Called when the object is removed from the sim.   DECLARE_CONOBJECT (AudioEmitter) Static Public Member Functions static void  initPersistFields ()   Register dynamic fields in a subclass of ConsoleObject. Private Types typedef SceneObject  Parent enum   Dirty {   Profile = BIT(0),   Description = BIT(1),   Filename = BIT(2),   UseProfileDescription = BIT(3),   Volume = BIT(4),   IsLooping = BIT(5),   Is3D = BIT(6),   ReferenceDistance = BIT(7),   MaxDistance = BIT(8),   ConeInsideAngle = BIT(9),   ConeOutsideAngle = BIT(10),   ConeOutsideVolume = BIT(11),   ConeVector = BIT(12),   LoopCount = BIT(13),   MinLoopGap = BIT(14),   MaxLoopGap = BIT(15),   Transform = BIT(16),   AudioType = BIT(17),   OutsideAmbient = BIT(18),   AllDirtyMask = BIT(19) - 1,   SourceMask = (Profile|Description|Filename),   LoopingMask = (LoopCount|MinLoopGap|MaxLoopGap),   Is3DMask = (ReferenceDistance|MaxDistance|ConeInsideAngle|ConeOutsideAngle|ConeOutsideVolume|ConeVector),   UseProfileDescriptionMask = (Volume|LoopingMask|Is3DMask|IsLooping|Is3D|AudioType) } Private Member Functions bool  readDirtyFlag (BitStream *, U32) Private Attributes AUDIOHANDLE  mAudioHandle U32  mAudioProfileId U32  mAudioDescriptionId AudioProfile *  mAudioProfile AudioDescription *  mAudioDescription StringTableEntry  mFilename bool  mUseProfileDescription Audio::Description  mDescription bool  mOutsideAmbient S32  mLoopCount U32  mEventID bool  mEnableVisualFeedback bool  mOwnedByClient F32  mAnimRotAngle BitSet32  mDirty Static Private Attributes static Audio::Description  smDefaultDescription Friends class  AmbientAudioManager class  AudioEmitterToEvent Member Typedef Documentation typedef SceneObject AudioEmitter::Parent [private]   Reimplemented from SceneObject. Member Enumeration Documentation enum AudioEmitter::Dirty [private]   Enumeration values: Profile  Description  Filename  UseProfileDescription  Volume  IsLooping  Is3D  ReferenceDistance  MaxDistance  ConeInsideAngle  ConeOutsideAngle  ConeOutsideVolume  ConeVector  LoopCount  MinLoopGap  MaxLoopGap  Transform  AudioType  OutsideAmbient  AllDirtyMask  SourceMask  LoopingMask  Is3DMask  UseProfileDescriptionMask  enum AudioEmitter::UpdateMasks   Enumeration values: InitialUpdateMask  TransformUpdateMask  DirtyUpdateMask  Constructor & Destructor Documentation AudioEmitter::AudioEmitter (  bool  client = false  )  Member Function Documentation bool AudioEmitter::readDirtyFlag (  BitStream *  , U32  )  [private] void AudioEmitter::processLoopEvent (   )  bool AudioEmitter::update (   )  void AudioEmitter::packData (  NetConnection *  conn, U32  mask, BitStream *  stream )  void AudioEmitter::unpackData (  NetConnection *  conn, BitStream *  stream )  void AudioEmitter::setTransform (  const MatrixF &  mat  )  [virtual]   Sets the Object -> World transform. Parameters: mat  New transform matrix Reimplemented from SceneObject. void AudioEmitter::setScale (  const VectorF &  scale  )  [virtual]   Sets the scale for the object. Parameters: scale  Scaling values Reimplemented from SceneObject. void AudioEmitter::inspectPreApply (   )  [virtual]   Called before any property of the object is changed in the world editor. The calling order here is: inspectPreApply() ... calls to setDataField() ... inspectPostApply() Reimplemented from SimObject. void AudioEmitter::inspectPostApply (   )  [virtual]   Called after any property of the object is changed in the world editor. See also: inspectPreApply Reimplemented from SceneObject. bool AudioEmitter::prepRenderImage (  SceneState *  state, const U32  stateKey, const U32  startZone, const bool  modifyBaseZoneState )  [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. void AudioEmitter::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. void AudioEmitter::render3DVisualFeedBack (  void   )  U32 AudioEmitter::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 AudioEmitter::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. bool AudioEmitter::onAdd (   )  [virtual]   Called when the object is added to the sim. Reimplemented from SceneObject. void AudioEmitter::onRemove (   )  [virtual]   Called when the object is removed from the sim. Reimplemented from SceneObject. static void AudioEmitter::initPersistFields (   )  [static]   Register dynamic fields in a subclass of ConsoleObject. See also: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup() Reimplemented from SceneObject. AudioEmitter::DECLARE_CONOBJECT (  AudioEmitter   )  Friends And Related Function Documentation friend class AmbientAudioManager [friend] friend class AudioEmitterToEvent [friend] Field Documentation AUDIOHANDLE AudioEmitter::mAudioHandle [private] U32 AudioEmitter::mAudioProfileId [private] U32 AudioEmitter::mAudioDescriptionId [private] AudioProfile* AudioEmitter::mAudioProfile [private] AudioDescription* AudioEmitter::mAudioDescription [private] StringTableEntry AudioEmitter::mFilename [private] bool AudioEmitter::mUseProfileDescription [private] Audio::Description AudioEmitter::smDefaultDescription [static, private] Audio::Description AudioEmitter::mDescription [private] bool AudioEmitter::mOutsideAmbient [private] S32 AudioEmitter::mLoopCount [private] U32 AudioEmitter::mEventID [private] bool AudioEmitter::mEnableVisualFeedback [private] bool AudioEmitter::mOwnedByClient [private] F32 AudioEmitter::mAnimRotAngle [private] BitSet32 AudioEmitter::mDirty [private]

---

All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen