Blender  V2.59
Public Types | Public Member Functions | Public Attributes
KX_SoundActuator Class Reference

#include <KX_SoundActuator.h>

Inheritance diagram for KX_SoundActuator:
Inheritance graph
[legend]

List of all members.

Public Types

enum  KX_SOUNDACT_TYPE {
  KX_SOUNDACT_NODEF = 0, KX_SOUNDACT_PLAYSTOP, KX_SOUNDACT_PLAYEND, KX_SOUNDACT_LOOPSTOP,
  KX_SOUNDACT_LOOPEND, KX_SOUNDACT_LOOPBIDIRECTIONAL, KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP, KX_SOUNDACT_MAX
}

Public Member Functions

 KX_SoundActuator (SCA_IObject *gameobj, AUD_Sound *sound, float volume, float pitch, bool is3d, KX_3DSoundSettings settings, KX_SOUNDACT_TYPE type)
 ~KX_SoundActuator ()
virtual bool Update (double curtime, bool frame)
CValueGetReplica ()
void ProcessReplica ()

Public Attributes

KX_SOUNDACT_TYPE m_type

Detailed Description

Definition at line 57 of file KX_SoundActuator.h.


Member Enumeration Documentation

Enumerator:
KX_SOUNDACT_NODEF 
KX_SOUNDACT_PLAYSTOP 
KX_SOUNDACT_PLAYEND 
KX_SOUNDACT_LOOPSTOP 
KX_SOUNDACT_LOOPEND 
KX_SOUNDACT_LOOPBIDIRECTIONAL 
KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP 
KX_SOUNDACT_MAX 

Definition at line 72 of file KX_SoundActuator.h.


Constructor & Destructor Documentation

KX_SoundActuator::KX_SoundActuator ( SCA_IObject gameobj,
AUD_Sound sound,
float  volume,
float  pitch,
bool  is3d,
KX_3DSoundSettings  settings,
KX_SOUNDACT_TYPE  type 
)

Definition at line 51 of file KX_SoundActuator.cpp.

References m_type, and NULL.

Referenced by GetReplica().

KX_SoundActuator::~KX_SoundActuator ( )

Definition at line 72 of file KX_SoundActuator.cpp.

References AUD_stop().


Member Function Documentation

CValue * KX_SoundActuator::GetReplica ( void  ) [virtual]

Implements CValue.

Definition at line 137 of file KX_SoundActuator.cpp.

References KX_SoundActuator(), and ProcessReplica().

void KX_SoundActuator::ProcessReplica ( ) [virtual]

Makes sure any internal data owned by this class is deep copied.

Reimplemented from SCA_IActuator.

Definition at line 144 of file KX_SoundActuator.cpp.

Referenced by GetReplica().

bool KX_SoundActuator::Update ( double  curtime,
bool  frame 
) [virtual]

Update(...) Update the actuator based upon the events received since the last call to Update, the current time and deltatime the time elapsed in this frame ? It is the responsibility of concrete Actuators to clear their event's. This is usually done in the Update() method via a call to RemoveAllEvents()

Reimplemented from SCA_IActuator.

Definition at line 150 of file KX_SoundActuator.cpp.

References AUD_getPosition(), AUD_getStatus(), AUD_pause(), AUD_resume(), AUD_seek(), AUD_setAttenuation(), AUD_setConeAngleInner(), AUD_setConeAngleOuter(), AUD_setConeVolumeOuter(), AUD_setDistanceMaximum(), AUD_setDistanceReference(), AUD_setLoop(), AUD_setSoundPitch(), AUD_setSoundVolume(), AUD_setSourceLocation(), AUD_setSourceOrientation(), AUD_setSourceVelocity(), AUD_setVolumeMaximum(), AUD_setVolumeMinimum(), AUD_STATUS_PAUSED, AUD_STATUS_PLAYING, AUD_stop(), KX_3DSoundSettings::cone_inner_angle, KX_3DSoundSettings::cone_outer_angle, KX_3DSoundSettings::cone_outer_gain, KX_GameObject::GetLinearVelocity(), SCA_ILogicBrick::GetParent(), MT_Matrix3x3::getRotation(), MT_Tuple3::getValue(), MT_Tuple4::getValue(), SCA_IActuator::IsNegativeEvent(), KX_SOUNDACT_LOOPBIDIRECTIONAL, KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP, KX_SOUNDACT_LOOPEND, KX_SOUNDACT_LOOPSTOP, KX_SOUNDACT_MAX, KX_SOUNDACT_NODEF, KX_SOUNDACT_PLAYEND, KX_SOUNDACT_PLAYSTOP, SCA_ILogicBrick::m_name, SCA_IActuator::m_posevent, m_type, KX_3DSoundSettings::max_distance, KX_3DSoundSettings::max_gain, KX_3DSoundSettings::min_gain, KX_GameObject::NodeGetWorldOrientation(), KX_GameObject::NodeGetWorldPosition(), NULL, pauseSound(), KX_3DSoundSettings::reference_distance, SCA_IActuator::RemoveAllEvents(), and KX_3DSoundSettings::rolloff_factor.


Member Data Documentation

Reimplemented from SCA_IActuator.

Definition at line 84 of file KX_SoundActuator.h.

Referenced by KX_SoundActuator(), and Update().


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