This is an interface class for a listener (such as a player) in the 3D audio world. More...

#include <listener.h>

Inheritance diagram for Mezzanine::Audio::iListener:

Collaboration diagram for Mezzanine::Audio::iListener:

Public Member Functions
	iListener ()
	Class constructor.

virtual	~iListener ()
	Class destructor.

virtual Real	GetMetersPerUnit () const =0
	Gets the currently set number of meters in a single unit of world space. More...

virtual Vector3	GetVelocity () const =0
	Gets the current velocity of this listener. More...

virtual Real	GetVolumeModifier () const =0
	Gets the modifier applied to all audio heard by this listener. More...

virtual void	SetMetersPerUnit (const Real Meters)=0
	Sets the number of meters in a single unit of world space. More...

virtual void	SetVelocity (const Vector3 &Vel)=0
	Sets the moving velocity of this listener. More...

virtual void	SetVolumeModifier (const Real Vol)=0
	Sets the modifier to use that will adjust the volume of all audio heard by this listener. More...

Public Member Functions inherited from Mezzanine::WorldProxy
	WorldProxy ()
	Class constructor.

virtual	~WorldProxy ()
	Class destructor.

void	_Bind (WorldObject *NewParent)
	Binds this proxy to a WorldObject. More...

virtual void	AddToWorld ()=0
	Performs all the necessary task to ensure this object is connected to it's respective world and ready for use.

virtual WorldManager *	GetCreator () const =0
	Gets a pointer to this proxies creator. More...

virtual String	GetDerivedSerializableName () const
	Gets the most derived serializable name of this WorldProxy. More...

virtual Vector3	GetLocation () const =0
	Gets this objects current location. More...

virtual Quaternion	GetOrientation () const =0
	Gets this objects current orientation. More...

virtual WorldObject *	GetParentObject () const
	Gets a pointer to the parent object controlling this proxy. More...

virtual Mezzanine::ProxyType	GetProxyType () const =0
	Accessor for the type of proxy. More...

virtual Vector3	GetScale () const =0
	Gets the scaling currently being applied to this object. More...

virtual bool	IsInWorld () const =0
	Gets whether or not this object is inside of it's world. More...

virtual void	Pitch (const Real Angle)=0
	Rotate the object around the X axis. More...

virtual void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...

virtual void	ProtoDeSerializeProperties (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite the properties of this object with it. More...

virtual void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...

virtual void	ProtoSerializeProperties (XML::Node &SelfRoot) const
	Convert the properties of this class to an XML::Node ready for serialization. More...

virtual void	RemoveFromWorld ()=0
	Unhooks this proxy from it's respective world.

virtual void	Roll (const Real Angle)=0
	Rotate the object around the Z axis. More...

virtual void	Rotate (const Vector3 &Axis, const Real Angle)=0
	Rotates the object from it's existing rotation. More...

virtual void	Rotate (const Quaternion &Rotation)=0
	Rotates the object from it's existing rotation. More...

virtual void	Scale (const Vector3 &Scale)=0
	Scales the object from it's current size. More...

virtual void	Scale (const Real X, const Real Y, const Real Z)=0
	Scales the object from it's current size. More...

virtual void	SetLocation (const Vector3 &Loc)=0
	Sets the location of this object in parent space. More...

virtual void	SetLocation (const Real X, const Real Y, const Real Z)=0
	Sets the location of this object in parent space via Reals. More...

virtual void	SetOrientation (const Quaternion &Ori)=0
	Sets the orientation of this object in parent space. More...

virtual void	SetOrientation (const Real X, const Real Y, const Real Z, const Real W)=0
	Sets the orientation of this object in parent space via Reals. More...

virtual void	SetScale (const Vector3 &Sc)=0
	Sets the scaling to be applied to this object. More...

virtual void	SetScale (const Real X, const Real Y, const Real Z)=0
	Sets the scaling to be applied to this object via Reals. More...

virtual void	Translate (const Vector3 &Trans)=0
	Moves this object from it's current location. More...

virtual void	Translate (const Real X, const Real Y, const Real Z)=0
	Moves this object from it's current location. More...

virtual void	Yaw (const Real Angle)=0
	Rotate the object around the Y axis. More...

Public Member Functions inherited from Mezzanine::TransformableObject
virtual	~TransformableObject ()
	Class Destructor.

virtual Vector3	ConvertGlobalToLocal (const Vector3 &Location) const
	Converts a point in global space to the same point in local space. More...

virtual Quaternion	ConvertGlobalToLocal (const Quaternion &Orientation) const
	Converts a rotation in global space to the same rotation in local space. More...

virtual Vector3	ConvertLocalToGlobal (const Vector3 &Location) const
	Converts a point in local space to the same point in global space. More...

virtual Quaternion	ConvertLocalToGlobal (const Quaternion &Orientation) const
	Converts a rotation in local space to the same rotation in global space. More...

Static Public Member Functions
static String	SerializableName ()
	Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized. More...

Static Public Member Functions inherited from Mezzanine::WorldProxy
static String	GetSerializableName ()
	Get the name of the the XML tag the proxy class will leave behind as its instances are serialized. More...

Additional Inherited Members
Protected Attributes inherited from Mezzanine::WorldProxy
WorldObject *	ParentObject
	Pointer to the Object this proxy belongs to. More...

Detailed Description

This is an interface class for a listener (such as a player) in the 3D audio world.

Definition at line 56 of file listener.h.

Member Function Documentation

virtual Real Mezzanine::Audio::iListener::GetMetersPerUnit ( ) const

pure virtual

Gets the currently set number of meters in a single unit of world space.

Returns: Returns a Real representing the number of meters in a unit of world space.

virtual Vector3 Mezzanine::Audio::iListener::GetVelocity ( ) const

pure virtual

Gets the current velocity of this listener.

Returns: Returns a Vector3 containing the current velocity of this listener.

virtual Real Mezzanine::Audio::iListener::GetVolumeModifier ( ) const

pure virtual

Gets the modifier applied to all audio heard by this listener.

Returns: Returns the currently set volume modifier.

static String Mezzanine::Audio::iListener::SerializableName ( )

inlinestatic

Get the name of the the XML tag the Renderable class will leave behind as its instances are serialized.

Returns: A string containing the name of this class.

Definition at line 92 of file listener.h.

virtual void Mezzanine::Audio::iListener::SetMetersPerUnit ( const Real Meters)

pure virtual

Sets the number of meters in a single unit of world space.

Parameters

Meters The number of meters in a single unit of world space.

virtual void Mezzanine::Audio::iListener::SetVelocity ( const Vector3 & Vel)

pure virtual

Sets the moving velocity of this listener.

Parameters

Vel	The velocity this listener is to be given.

virtual void Mezzanine::Audio::iListener::SetVolumeModifier ( const Real Vol)

pure virtual

Sets the modifier to use that will adjust the volume of all audio heard by this listener.

Parameters

Vol	The modifier to be set. Range 0.0 to +Inf.

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

/home/sqeaky/Code/Mezzanine/Mezzanine/src/Audio/listener.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation