Aether3D Game Engine
Public Member Functions | Friends | List of all members
ae3d::AudioSourceComponent Class Reference

Contains an audio clip and methods to play it. More...

#include <AudioSourceComponent.hpp>

Public Member Functions

class GameObjectGetGameObject () const
 
bool Is3D () const
 
void SetClipId (unsigned audioClipId)
 
void Set3D (bool enable)
 
void Play () const
 Plays the clip.
 
std::string GetSerialized () const
 

Friends

class GameObject
 

Detailed Description

Contains an audio clip and methods to play it.

See also
AudioClip

Member Function Documentation

class GameObject* ae3d::AudioSourceComponent::GetGameObject ( ) const
inline
Returns
GameObject that owns this component.
std::string ae3d::AudioSourceComponent::GetSerialized ( ) const
Returns
Textual representation of component.
bool ae3d::AudioSourceComponent::Is3D ( ) const
inline
Returns
True, if clips played through this source will be affected by this game object's and camera's position.
void ae3d::AudioSourceComponent::Set3D ( bool  enable)
inline
Parameters
enableTrue, if clips played through this source will be affected by this GameObject's and camera's position.
void ae3d::AudioSourceComponent::SetClipId ( unsigned  audioClipId)
Parameters
audioClipIdAudio clip id.

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