dtActors::SoundActorProxy Class Reference

This proxy wraps the Sound Delta3D object. More...

#include <soundactorproxy.h>

Inheritance diagram for dtActors::SoundActorProxy:

List of all members.

Public Member Functions
	SoundActorProxy ()
	Constructor.
virtual void	BuildPropertyMap ()
	Adds the properties that are common to all Delta3D physical objects.
void	LoadFile (const std::string &fileName)
	Loads in a sound file.
void	SetDirection (const osg::Vec3 &dir)
	Sets the direction.
osg::Vec3	GetDirection ()
	Gets the direction.
void	SetVelocity (const osg::Vec3 &vel)
	Sets the velocity.
osg::Vec3	GetVelocity ()
	Gets the velocity.
void	Play ()
	Plays the sound.
virtual const ActorProxy::RenderMode &	GetRenderMode ()
	Gets the render mode of sound actor proxies.
virtual dtDAL::ActorProxyIcon *	GetBillBoardIcon ()
	Gets the billboard icon associated with sound actor proxies.
void	BuildInvokables ()
	Builds the invokables of this actor.
void	HandleActorTimers (const dtGame::Message &msg)
void	OnEnteredWorld ()
	Called when an actor is first placed in the "world".
bool	IsARandomSoundEffect () const
void	SetToHaveRandomSoundEffect (bool value)
void	SetMinRandomTime (int value)
int	GetMinRandomTime () const
void	SetMaxRandomTime (int value)
int	GetMaxRandomTime () const
int	GetOffsetTime () const
void	SetOffsetTime (int value)
Protected Member Functions
virtual void	CreateActor ()
	Creates a new positional sound.
virtual	~SoundActorProxy ()
	Destructor.

---

Detailed Description

This proxy wraps the Sound Delta3D object.

---

Constructor & Destructor Documentation

dtActors::SoundActorProxy::SoundActorProxy

(

)

Constructor.

Note:

You must instantiate, configure, and shutdown the audiomanager in your application ex.

      dtAudio::AudioManager::Instantiate();
      dtAudio::AudioManager::GetManager()->Config(AudioConfigData&)

dtActors::SoundActorProxy::~SoundActorProxy

(

)

[protected, virtual]

Destructor.

---

Member Function Documentation

void dtActors::SoundActorProxy::BuildPropertyMap

(

)

[virtual]

Adds the properties that are common to all Delta3D physical objects.

Reimplemented from dtGame::GameActorProxy.

void dtActors::SoundActorProxy::LoadFile

(

const std::string &

fileName

)

Loads in a sound file.

Parameters:

fileName

The file to load

void dtActors::SoundActorProxy::SetDirection

(

const osg::Vec3 &

dir

)

Sets the direction.

Parameters:

dir

The direction to Set

osg::Vec3 dtActors::SoundActorProxy::GetDirection

(

)

Gets the direction.

Returns:

The current direction

void dtActors::SoundActorProxy::SetVelocity

(

const osg::Vec3 &

vel

)

Sets the velocity.

Parameters:

vel

The velocity to Set

osg::Vec3 dtActors::SoundActorProxy::GetVelocity

(

)

Gets the velocity.

Returns:

The current velocity

void dtActors::SoundActorProxy::Play

(

)

Plays the sound.

virtual const ActorProxy::RenderMode& dtActors::SoundActorProxy::GetRenderMode

(

)

[inline, virtual]

Gets the render mode of sound actor proxies.

Returns:

RenderMode::DRAW_ACTOR_AND_BILLBOARD_ICON. Although this may seem a little strange considering you cannot actually draw a sound, however, this informs the world that this proxy's actor and billboard should be represented in the scene.

Reimplemented from dtDAL::ActorProxy.

dtDAL::ActorProxyIcon * dtActors::SoundActorProxy::GetBillBoardIcon

(

)

[virtual]

Gets the billboard icon associated with sound actor proxies.

Returns:

Reimplemented from dtDAL::ActorProxy.

void dtActors::SoundActorProxy::BuildInvokables

(

)

[virtual]

Builds the invokables of this actor.

Reimplemented from dtGame::GameActorProxy.

void dtActors::SoundActorProxy::HandleActorTimers

(

const dtGame::Message &

msg

)

void dtActors::SoundActorProxy::OnEnteredWorld

(

)

[virtual]

Called when an actor is first placed in the "world".

Reimplemented from dtGame::GameActorProxy.

bool dtActors::SoundActorProxy::IsARandomSoundEffect

(

)

const [inline]

void dtActors::SoundActorProxy::SetToHaveRandomSoundEffect

(

bool

value

)

[inline]

void dtActors::SoundActorProxy::SetMinRandomTime

(

int

value

)

[inline]

int dtActors::SoundActorProxy::GetMinRandomTime

(

)

const [inline]

void dtActors::SoundActorProxy::SetMaxRandomTime

(

int

value

)

[inline]

int dtActors::SoundActorProxy::GetMaxRandomTime

(

)

const [inline]

int dtActors::SoundActorProxy::GetOffsetTime

(

)

const [inline]

void dtActors::SoundActorProxy::SetOffsetTime

(

int

value

)

[inline]

void dtActors::SoundActorProxy::CreateActor

(

)

[protected, virtual]

Creates a new positional sound.

Implements dtGame::GameActorProxy.

---