3D Sound node. More...

#include <Sound3D.h>

Inheritance diagram for kge::sn::Sound3D:

Public Member Functions
	Sound3D ()
	Constructor.
virtual	~Sound3D ()
	Destructor.
virtual void	PreRender (float elapsedTime=0.0f)
	Recalculate the sound position.
virtual void	Render ()
	Nothing to do.
virtual void	PostRender ()
	Nothing to do.
virtual bool	AddEffect (efx::EffectType p, efx::Effect **ppOut)
	Nothing to do.
virtual void	Draw (bool WithMaterial, bool WithTransform, bool bPosition, bool bNormalTexcoord, bool bTangentBinormal)
	Nothing to do.
virtual void	SetPosition (const math::Vector &v)=0
	Set the position of the sound.
virtual void	SetVelocity (const math::Vector &velocity)=0
	Set sound source velocity.
virtual math::Vector	GetVelocity () const
	Returns sound source velocity.
virtual void	SetVolume (float value)=0
	Set the sound source volume.
virtual float	GetVolume () const
	Get the sound source volume.
virtual void	SetLoopingState (bool looping)=0
	Sets looping of sound.
virtual bool	GetLoopingState () const
	Returns Sound lopping state.
virtual av::SourceStates	GetState () const =0
	sound source state
virtual av::SourceType	GetSoundType () const =0
	sound source type (static,streaming...)
virtual void	Play ()=0
	play source (sound)
virtual void	Pause ()=0
	pause playing source (sound)
virtual void	Stop ()=0
	stop playing source (sound)
virtual void	SetMinMaxDistance (float _min, float _max=10000.0f)=0
	set max and min distance
virtual void	SetFading (float value, unsigned int time)=0
Public Member Functions inherited from kge::sn::SceneNode
	SceneNode ()
	Constructor.
virtual	~SceneNode ()
	Destructor.
virtual void	AddChild (SceneNode *child)
	Adds a node as child.
virtual void	SetSceneManager (SceneManager *smgr)
	Sets the scene manager and renderer pointer.
virtual void	SetRotation (const math::Vector &v)
	Set the rotation of the scenenode.
virtual void	SetScale (const math::Vector &v)
	Set the scale of the scenenode.
virtual void	SetAutomaticCulling (bool isTrue)
	Set Cutting Enable or Disable.
virtual void	SetVisible (bool isVisible)
	Set Visible Enable or Disable.
virtual bool	GetVisible ()
	Get Visible.
virtual bool	IsVisibleInFrame ()
	Is it visible in this frame?
virtual const math::Vector &	GetPosition () const
	Returns the node position.
virtual const math::Vector &	GetRotation () const
	Returns the node rotation.
virtual const math::Vector &	GetScale () const
	Returns the node scale.
virtual math::Matrix *	GetAbsoluteMatrix () const
	Get the absolute matrix.
virtual math::Matrix *	GetFinalMatrix ()
	Get the final matrix.
virtual u32	GetMaterialCount ()
	Get the count of materials this node has.
virtual gfx::Material *	GetMaterial (u32 Index)
virtual math::Sphere *	GetBoundingBox ()
	Returns the node bounding box.
virtual math::AABB *	GetAxisAlignedBoundingBox ()
	Returns the node Axis aligned bounding box.
virtual NodeType	GetType () const
	Returns the node type.
virtual void	RemoveChild (SceneNode *child)
virtual void	RemoveChildren ()
	Removes all children of this node.
virtual const SceneNode *	GetParent ()
	Returns the node parent.
virtual void	SetParent (SceneNode *parent)
	Sets the node parent.
virtual void	SetName (const char *name)
	Sets the node name.
virtual core::String *	GetName ()
	Gets the node name.
virtual void	SetID (int ID)
	Sets the node ID.
virtual int	GetID ()
	Gets the node ID.
void	EnableShadow (bool enable)
bool	HasShadow () const
virtual void	UpdateFinalMat ()
	Update final matrix.
Public Member Functions inherited from kge::KgeUnknown
	KgeUnknown ()
	Constructor.
virtual	~KgeUnknown ()
	Destructor.
virtual void	AddRef ()
	Add a reference to the object.
virtual void	DecRef ()
	Decrease a reference from the object. if its reference count get 0 then the object will destroy.
u32	GetRefCount ()
	Return resource reference count.
const char *	GetDebugText ()
	returns the instance debug text.

Protected Attributes
math::Vector	m_velocity
float	m_volume
bool	m_looping
Protected Attributes inherited from kge::sn::SceneNode
core::String	m_sName
int	m_iID
SceneManager *	m_pSnMan
gfx::Renderer *	m_pRenderer
bool	m_bVis
bool	m_bAutoCulling
bool	m_bVisFrame
SceneNode *	m_pParent
std::vector< SceneNode * >	m_vChilds
std::vector< int >	m_vEffectType
std::vector< efx::Effect * >	m_vEffect
math::Matrix *	m_pAbsMat
math::Matrix *	m_pFinalMat
math::Vector	m_Position
math::Vector	m_Rotation
math::Vector	m_Scale
math::Sphere *	m_pBB
math::AABB *	m_pAABB
NodeType	m_eNodeType
bool	m_hasShadow

Additional Inherited Members
Protected Member Functions inherited from kge::sn::SceneNode
virtual bool	HasThisEffect (efx::EffectType p)

Detailed Description

3D Sound node.

Definition at line 18 of file Sound3D.h.

Constructor & Destructor Documentation

kge::sn::Sound3D::Sound3D ( )

inline

Constructor.

Definition at line 23 of file Sound3D.h.

virtual kge::sn::Sound3D::~Sound3D ( )

inlinevirtual

Destructor.

Definition at line 29 of file Sound3D.h.

Member Function Documentation

virtual bool kge::sn::Sound3D::AddEffect	(	efx::EffectType	p,
		efx::Effect **	ppOut
	)

inlinevirtual

Nothing to do.

Reimplemented from kge::sn::SceneNode.

Definition at line 41 of file Sound3D.h.

virtual void kge::sn::Sound3D::Draw	(	bool	WithMaterial,
		bool	WithTransform,
		bool	bPosition,
		bool	bNormalTexcoord,
		bool	bTangentBinormal
	)

inlinevirtual

Nothing to do.

Implements kge::sn::SceneNode.

Definition at line 44 of file Sound3D.h.

virtual bool kge::sn::Sound3D::GetLoopingState ( ) const

inlinevirtual

Returns Sound lopping state.

Definition at line 65 of file Sound3D.h.

virtual av::SourceType kge::sn::Sound3D::GetSoundType ( ) const

pure virtual

sound source type (static,streaming...)

virtual av::SourceStates kge::sn::Sound3D::GetState ( ) const

pure virtual

sound source state

virtual math::Vector kge::sn::Sound3D::GetVelocity ( ) const

inlinevirtual

Returns sound source velocity.

Definition at line 53 of file Sound3D.h.

virtual float kge::sn::Sound3D::GetVolume ( ) const

inlinevirtual

Get the sound source volume.

Definition at line 59 of file Sound3D.h.

virtual void kge::sn::Sound3D::Pause ( )

pure virtual

pause playing source (sound)

virtual void kge::sn::Sound3D::Play ( )

pure virtual

play source (sound)

virtual void kge::sn::Sound3D::PostRender ( )

inlinevirtual

Nothing to do.

Implements kge::sn::SceneNode.

Definition at line 38 of file Sound3D.h.

virtual void kge::sn::Sound3D::PreRender ( float elapsedTime = 0.0f )

inlinevirtual

Recalculate the sound position.

Implements kge::sn::SceneNode.

Definition at line 32 of file Sound3D.h.

virtual void kge::sn::Sound3D::Render ( )

inlinevirtual

Nothing to do.

Implements kge::sn::SceneNode.

Definition at line 35 of file Sound3D.h.

virtual void kge::sn::Sound3D::SetFading	(	float	value,
		unsigned int	time
	)

pure virtual

virtual void kge::sn::Sound3D::SetLoopingState ( bool looping )

pure virtual

Sets looping of sound.

virtual void kge::sn::Sound3D::SetMinMaxDistance	(	float	_min,
		float	_max = `10000.0f`
	)

pure virtual

set max and min distance

virtual void kge::sn::Sound3D::SetPosition ( const math::Vector & v )

pure virtual

Set the position of the sound.

Reimplemented from kge::sn::SceneNode.

virtual void kge::sn::Sound3D::SetVelocity ( const math::Vector & velocity )

pure virtual

Set sound source velocity.

virtual void kge::sn::Sound3D::SetVolume ( float value )

pure virtual

Set the sound source volume.

virtual void kge::sn::Sound3D::Stop ( )

pure virtual

stop playing source (sound)

Member Data Documentation

bool kge::sn::Sound3D::m_looping

protected

Definition at line 91 of file Sound3D.h.

math::Vector kge::sn::Sound3D::m_velocity

protected

Definition at line 89 of file Sound3D.h.

float kge::sn::Sound3D::m_volume

protected

Definition at line 90 of file Sound3D.h.

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

E:/mycodes/git/kge/Include/sn/Sound3D.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation