Kochol Game Engine  0.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
kge::sn::Sound2D Class Reference

#include <Sound2D.h>

Inheritance diagram for kge::sn::Sound2D:
kge::sn::SceneNode kge::KgeUnknown

Public Member Functions

 Sound2D ()
 Constructor.
virtual ~Sound2D ()
virtual void SetPan (float pan)=0
 Sets pan of sound in stereo speakers.
virtual float GetPan () const
 Returns pan.
virtual void SetVolume (float vol)=0
 Sets volume of the sound.
virtual float GetVolume () const
 Returns volume of the sound.
virtual void SetLoopingState (bool loop)=0
 Sets lopping of the sound.
virtual bool GetLoopingState () const
 Returns looping state of the sound.
virtual av::SourceStates GetState () const =0
 sound source state
virtual av::SourceType GetSoundType () const =0
 sound source type (static,streaming...)
virtual void Play ()=0
 Plays sound.
virtual void Pause ()=0
 Pause playing sound.
virtual void Stop ()=0
 Stops playing sound.
virtual void SetFading (float value, unsigned int time)=0
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.
- 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 SetPosition (const math::Vector &v)
 Set the position of the scenenode.
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::VectorGetPosition () const
 Returns the node position.
virtual const math::VectorGetRotation () const
 Returns the node rotation.
virtual const math::VectorGetScale () const
 Returns the node scale.
virtual math::MatrixGetAbsoluteMatrix () const
 Get the absolute matrix.
virtual math::MatrixGetFinalMatrix ()
 Get the final matrix.
virtual u32 GetMaterialCount ()
 Get the count of materials this node has.
virtual gfx::MaterialGetMaterial (u32 Index)
virtual math::SphereGetBoundingBox ()
 Returns the node bounding box.
virtual math::AABBGetAxisAlignedBoundingBox ()
 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 SceneNodeGetParent ()
 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::StringGetName ()
 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

float m_pan
float m_volume
bool m_looping
- Protected Attributes inherited from kge::sn::SceneNode
core::String m_sName
int m_iID
SceneManagerm_pSnMan
gfx::Rendererm_pRenderer
bool m_bVis
bool m_bAutoCulling
bool m_bVisFrame
SceneNodem_pParent
std::vector< SceneNode * > m_vChilds
std::vector< int > m_vEffectType
std::vector< efx::Effect * > m_vEffect
math::Matrixm_pAbsMat
math::Matrixm_pFinalMat
math::Vector m_Position
math::Vector m_Rotation
math::Vector m_Scale
math::Spherem_pBB
math::AABBm_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

Definition at line 17 of file Sound2D.h.

Constructor & Destructor Documentation

kge::sn::Sound2D::Sound2D ( )
inline

Constructor.

Definition at line 21 of file Sound2D.h.

virtual kge::sn::Sound2D::~Sound2D ( )
inlinevirtual

Definition at line 25 of file Sound2D.h.

Member Function Documentation

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

Nothing to do.

Reimplemented from kge::sn::SceneNode.

Definition at line 75 of file Sound2D.h.

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

Nothing to do.

Implements kge::sn::SceneNode.

Definition at line 78 of file Sound2D.h.

virtual bool kge::sn::Sound2D::GetLoopingState ( ) const
inlinevirtual

Returns looping state of the sound.

Definition at line 43 of file Sound2D.h.

References m_looping.

virtual float kge::sn::Sound2D::GetPan ( ) const
inlinevirtual

Returns pan.

Definition at line 31 of file Sound2D.h.

References m_pan.

virtual av::SourceType kge::sn::Sound2D::GetSoundType ( ) const
pure virtual

sound source type (static,streaming...)

virtual av::SourceStates kge::sn::Sound2D::GetState ( ) const
pure virtual

sound source state

virtual float kge::sn::Sound2D::GetVolume ( ) const
inlinevirtual

Returns volume of the sound.

Definition at line 37 of file Sound2D.h.

References m_volume.

virtual void kge::sn::Sound2D::Pause ( )
pure virtual

Pause playing sound.

virtual void kge::sn::Sound2D::Play ( )
pure virtual

Plays sound.

virtual void kge::sn::Sound2D::PostRender ( )
inlinevirtual

Nothing to do.

Implements kge::sn::SceneNode.

Definition at line 72 of file Sound2D.h.

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

Recalculate the sound position.

Implements kge::sn::SceneNode.

Definition at line 66 of file Sound2D.h.

virtual void kge::sn::Sound2D::Render ( )
inlinevirtual

Nothing to do.

Implements kge::sn::SceneNode.

Definition at line 69 of file Sound2D.h.

virtual void kge::sn::Sound2D::SetFading ( float  value,
unsigned int  time 
)
pure virtual
virtual void kge::sn::Sound2D::SetLoopingState ( bool  loop)
pure virtual

Sets lopping of the sound.

virtual void kge::sn::Sound2D::SetPan ( float  pan)
pure virtual

Sets pan of sound in stereo speakers.

virtual void kge::sn::Sound2D::SetVolume ( float  vol)
pure virtual

Sets volume of the sound.

virtual void kge::sn::Sound2D::Stop ( )
pure virtual

Stops playing sound.

Member Data Documentation

bool kge::sn::Sound2D::m_looping
protected

Definition at line 83 of file Sound2D.h.

Referenced by GetLoopingState().

float kge::sn::Sound2D::m_pan
protected

Definition at line 81 of file Sound2D.h.

Referenced by GetPan().

float kge::sn::Sound2D::m_volume
protected

Definition at line 82 of file Sound2D.h.

Referenced by GetVolume().


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