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.
void	setIsMainListener (bool value=true)
	Sets whether this listener is the main listener.
void	onPositionChange (void *p)
	Updates the position of the component after its parent has been updated.
void	onRotationChange (void *p)
	Updates the rotation 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 bool	parseXML (IXMLReader *file, Entity *entity)
	Parses for a SoundListenerComponent.

---

Detailed Description

Component wrapper of SFML's sf::Listener.

XML:

 <SoundListenerComponent>
    <!-- Properties -->
 </SoundListenerComponent>

Definition at line 34 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 27 of file SoundListenerComponent.cpp.

SoundListenerComponent::~SoundListenerComponent

(

)

Deconstructor.

Definition at line 51 of file SoundListenerComponent.cpp.

---

Member Function Documentation

bool SoundListenerComponent::getIsMainListener

(

)

const

Checks if this listener is the main listener.

Definition at line 57 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 101 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 85 of file SoundListenerComponent.cpp.

void SoundListenerComponent::onRotationChange

(

void *

p

)

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

Note:

For internal use only!

Definition at line 93 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 108 of file SoundListenerComponent.cpp.

bool SoundListenerComponent::parseXML	(	IXMLReader *	file,
		Entity *	entity
	)			[static]

Parses for a SoundListenerComponent.

Note:

For internal use only!

Definition at line 115 of file SoundListenerComponent.cpp.

void SoundListenerComponent::setIsMainListener

(

bool

value = true

)

Sets whether this listener is the main listener.

XML:

     <isMainListener value="" />

Parameters:

value

Value to enable or disable this option.

Definition at line 63 of file SoundListenerComponent.cpp.

---

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

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