SoundListenerComponent Class Reference

Component wrapper of SFML's sf::Listener. More...

Inheritance diagram for SoundListenerComponent:

[legend]

Collaboration diagram for SoundListenerComponent:

[legend]

List of all members.

Public Member Functions
	SoundListenerComponent (Entity *parent, bool isMainListener=true)
	Constructor.
	~SoundListenerComponent ()
	Deconstructor.
bool	getIsMainListener () const
	Checks if this listener is the main listener.
const vector3df &	getTarget () const
	Gets the target direction of this listener.
void	setIsMainListener (bool value=true)
	Sets whether this listener is the main listener.
void	setTarget (const vector3df &target)
	Sets the target direction of this listener.
void	onPositionChange (void *p)
	Updates the position of the component after its parent has been updated.
void	onPause (void *p)
	Pauses the component if the parent is paused.
void	onUnPause (void *p)
	Unpauses the component if the parent is unpaused.
Static Public Member Functions
static SoundListenerComponent *	refFactory (Entity *parent, bool isMainListener=true)
	Will be used to instanciate objects of this class.

---

Detailed Description

Component wrapper of SFML's sf::Listener.

Definition at line 26 of file SoundListenerComponent.h.

---

Constructor & Destructor Documentation

SoundListenerComponent::SoundListenerComponent	(	Entity *	parent,
		bool	isMainListener = true
	)

Constructor.

Parameters:

	parent	The parent entity to which the component should be added.
	isMainListener	Sets whether this is the main listener.

Definition at line 26 of file SoundListenerComponent.cpp.

SoundListenerComponent::~SoundListenerComponent

(

)

Deconstructor.

Definition at line 54 of file SoundListenerComponent.cpp.

---

Member Function Documentation

bool SoundListenerComponent::getIsMainListener

(

)

const

Checks if this listener is the main listener.

Definition at line 66 of file SoundListenerComponent.cpp.

const vector3df & SoundListenerComponent::getTarget

(

)

const

Gets the target direction of this listener.

Definition at line 72 of file SoundListenerComponent.cpp.

void SoundListenerComponent::onPause

(

void *

p

)

Pauses the component if the parent is paused.

Note:

For internal use only!

Definition at line 116 of file SoundListenerComponent.cpp.

void SoundListenerComponent::onPositionChange

(

void *

p

)

Updates the position of the component after its parent has been updated.

Note:

For internal use only!

Definition at line 108 of file SoundListenerComponent.cpp.

void SoundListenerComponent::onUnPause

(

void *

p

)

Unpauses the component if the parent is unpaused.

Note:

For internal use only!

Definition at line 123 of file SoundListenerComponent.cpp.

SoundListenerComponent * SoundListenerComponent::refFactory	(	Entity *	parent,
		bool	isMainListener = true
	)			[static]

Will be used to instanciate objects of this class.

Note:

For internal use only!

Definition at line 60 of file SoundListenerComponent.cpp.

void SoundListenerComponent::setIsMainListener

(

bool

value = true

)

Sets whether this listener is the main listener.

Parameters:

value

Value to enable or disable this option.

Definition at line 78 of file SoundListenerComponent.cpp.

void SoundListenerComponent::setTarget

(

const vector3df &

target

)

Sets the target direction of this listener.

Parameters:

target

Position of the point the listener must look at.

Definition at line 99 of file SoundListenerComponent.cpp.

---

The documentation for this class was generated from the following files:

• components/sound/SoundListenerComponent.h
• components/sound/SoundListenerComponent.cpp