Gizmo3D

gzAudioSource Class Reference

#include <gzAudioSource.h>

Inheritance diagram for gzAudioSource:

gzNode gzBoundary gzNodeActionProvider gzNameInterface gzDebugInterface gzIntersectMask gzUpdateIDInterface gzCullMask gzObject gzUserData gzReference gzSerializeData gzSharedMemory gzTypeInterface List of all members.

Public Member Functions

 gzAudioSource (const gzString &name=GZ_EMPTY_STRING)
virtual ~gzAudioSource ()
 GZ_DECLARE_TYPE_INTERFACE_EXPORT (1)
virtual gzVoid updateNode ()
virtual gzReferenceclone () const
gzBool addData (gzAudioSourceFormat format, gzVoid *data, gzULong samples, gzULong frequency, gzUByte stride=0)
gzBool play (const gzFloat &offset=0.0)
gzBool pause ()
gzBool resume ()
gzBool stop ()
gzBool loop (gzBool on=FALSE)
gzAudioSourceState getAudioSourceState ()
gzBool setPosition (const gzVec3 &position, gzBool immediate=FALSE)
gzBool setOrientation (gzReal heading, gzReal pitch, gzReal roll, gzBool immediate=FALSE)
gzBool setDirection (const gzVec3 &targetvector, gzReal roll, const gzVec3 &up=gzVec3(0, 1, 0), gzBool immediate=FALSE)
gzVoid cleanBuffers ()
gzInt getPendingBuffers ()
 Returns -1 for error, else number of buffers.
virtual gzVoid preTraverseAction (gzTraverseAction *actionclass, gzContext *context)

Static Public Member Functions

static gzBool play (const gzRefList< gzAudioSource > &sources, const gzFloat &offset=0.0)
static gzBool pause (const gzRefList< gzAudioSource > &sources)
static gzBool resume (const gzRefList< gzAudioSource > &sources)
static gzBool stop (const gzRefList< gzAudioSource > &sources)

Protected Member Functions

gzUInt init ()

Protected Attributes

gzUInt m_sourceID
gzVec3 m_position
gzVec3 m_orientation
gzDynamicArray< gzUBytem_buffer

Detailed Description

Definition at line 66 of file gzAudioSource.h.


Constructor & Destructor Documentation

gzAudioSource::gzAudioSource const gzString name = GZ_EMPTY_STRING  ) 
 

virtual gzAudioSource::~gzAudioSource  )  [virtual]
 


Member Function Documentation

gzBool gzAudioSource::addData gzAudioSourceFormat  format,
gzVoid data,
gzULong  samples,
gzULong  frequency,
gzUByte  stride = 0
 

gzVoid gzAudioSource::cleanBuffers  ) 
 

virtual gzReference* gzAudioSource::clone  )  const [virtual]
 

Reimplemented from gzNode.

gzAudioSourceState gzAudioSource::getAudioSourceState  ) 
 

gzInt gzAudioSource::getPendingBuffers  ) 
 

Returns -1 for error, else number of buffers.

gzAudioSource::GZ_DECLARE_TYPE_INTERFACE_EXPORT  ) 
 

Reimplemented from gzNode.

gzUInt gzAudioSource::init  )  [protected]
 

gzBool gzAudioSource::loop gzBool  on = FALSE  ) 
 

static gzBool gzAudioSource::pause const gzRefList< gzAudioSource > &  sources  )  [static]
 

gzBool gzAudioSource::pause  ) 
 

static gzBool gzAudioSource::play const gzRefList< gzAudioSource > &  sources,
const gzFloat offset = 0.0
[static]
 

gzBool gzAudioSource::play const gzFloat offset = 0.0  ) 
 

virtual gzVoid gzAudioSource::preTraverseAction gzTraverseAction actionclass,
gzContext context
[virtual]
 

Reimplemented from gzNode.

static gzBool gzAudioSource::resume const gzRefList< gzAudioSource > &  sources  )  [static]
 

gzBool gzAudioSource::resume  ) 
 

gzBool gzAudioSource::setDirection const gzVec3 targetvector,
gzReal  roll,
const gzVec3 up = gzVec3(0, 1, 0),
gzBool  immediate = FALSE
 

gzBool gzAudioSource::setOrientation gzReal  heading,
gzReal  pitch,
gzReal  roll,
gzBool  immediate = FALSE
 

gzBool gzAudioSource::setPosition const gzVec3 position,
gzBool  immediate = FALSE
 

static gzBool gzAudioSource::stop const gzRefList< gzAudioSource > &  sources  )  [static]
 

gzBool gzAudioSource::stop  ) 
 

virtual gzVoid gzAudioSource::updateNode  )  [virtual]
 

Reimplemented from gzNode.


Member Data Documentation

gzDynamicArray<gzUByte> gzAudioSource::m_buffer [protected]
 

Definition at line 127 of file gzAudioSource.h.

gzVec3 gzAudioSource::m_orientation [protected]
 

Definition at line 125 of file gzAudioSource.h.

gzVec3 gzAudioSource::m_position [protected]
 

Definition at line 124 of file gzAudioSource.h.

gzUInt gzAudioSource::m_sourceID [protected]
 

Definition at line 123 of file gzAudioSource.h.


The documentation for this class was generated from the following file:
Documentation for Gizmo3D generated at Wed Feb 20 11:54:15 2008 by   Saab Training Systems AB, ¸ (c) 2003-and beyond