Inheritance diagram for OpenALAudioSound:

Public Member Functions
void	finished ()

virtual TypeHandle	force_init_type ()

void	get_3d_attributes (PN_stdfloat px, PN_stdfloat py, PN_stdfloat pz, PN_stdfloat vx, PN_stdfloat vy, PN_stdfloat vz)
	Get position and velocity of this sound Currently unimplemented. More...

PN_stdfloat	get_3d_drop_off_factor () const
	Control the effect distance has on audability. More...

PN_stdfloat	get_3d_max_distance () const
	Get the distance that this sound stops falling off. More...

PN_stdfloat	get_3d_min_distance () const
	Get the distance that this sound begins to fall off. More...

bool	get_active () const
	Returns whether the sound has been marked "active". More...

PN_stdfloat	get_balance () const
	-1.0 to 1.0 scale -1 should be all the way left. More...

const std::string &	get_finished_event () const

bool	get_loop () const
	Returns whether looping is on or off. More...

unsigned long	get_loop_count () const
	Return how many times a sound will loop. More...

const std::string &	get_name () const
	Get name of sound file. More...

PN_stdfloat	get_play_rate () const

PN_stdfloat	get_time () const
	Gets the play position within the sound. More...

virtual TypeHandle	get_type () const

PN_stdfloat	get_volume () const
	Gets the current volume of a sound. More...

PN_stdfloat	length () const
	Get length. More...

void	play ()
	Plays a sound. More...

void	set_3d_attributes (PN_stdfloat px, PN_stdfloat py, PN_stdfloat pz, PN_stdfloat vx, PN_stdfloat vy, PN_stdfloat vz)
	Set position and velocity of this sound. More...

void	set_3d_drop_off_factor (PN_stdfloat factor)
	Control the effect distance has on audability. More...

void	set_3d_max_distance (PN_stdfloat dist)
	Set the distance that this sound stops falling off. More...

void	set_3d_min_distance (PN_stdfloat dist)
	Set the distance that this sound begins to fall off. More...

void	set_active (bool active=true)
	Sets whether the sound is marked "active". More...

void	set_balance (PN_stdfloat balance_right=0.0)
	-1.0 to 1.0 scale More...

void	set_finished_event (const std::string &event)

void	set_loop (bool loop=true)
	Turns looping on and off. More...

void	set_loop_count (unsigned long loop_count=1)

void	set_play_rate (PN_stdfloat play_rate=1.0f)
	Sets the speed at which a sound plays back. More...

void	set_time (PN_stdfloat time=0.0)
	The next time you call play, the sound will start from the specified offset. More...

void	set_volume (PN_stdfloat volume=1.0)
	0.0 to 1.0 scale of volume converted to Fmod's internal 0.0 to 255.0 scale. More...

AudioSound::SoundStatus	status () const
	Get status of the sound. More...

void	stop ()
	Stop a sound. More...

Public Member Functions inherited from AudioSound
virtual bool	configure_filters (FilterProperties *config)
	Configure the local DSP filter chain. More...

virtual int	get_priority ()

virtual PN_stdfloat	get_speaker_level (int index)
	For use only with Miles. More...

virtual PN_stdfloat	get_speaker_mix (int speaker)
	For use only with FMOD. More...

virtual void	output (std::ostream &out) const

virtual void	set_priority (int priority)

virtual void	set_speaker_levels (PN_stdfloat level1, PN_stdfloat level2=-1.0f, PN_stdfloat level3=-1.0f, PN_stdfloat level4=-1.0f, PN_stdfloat level5=-1.0f, PN_stdfloat level6=-1.0f, PN_stdfloat level7=-1.0f, PN_stdfloat level8=-1.0f, PN_stdfloat level9=-1.0f)
	For use only with Miles. More...

virtual void	set_speaker_mix (PN_stdfloat frontleft, PN_stdfloat frontright, PN_stdfloat center, PN_stdfloat sub, PN_stdfloat backleft, PN_stdfloat backright, PN_stdfloat sideleft, PN_stdfloat sideright)
	For use only with FMOD. More...

virtual void	write (std::ostream &out) const

Public Member Functions inherited from TypedReferenceCount
	TypedReferenceCount (const TypedReferenceCount &copy)

void	operator= (const TypedReferenceCount &copy)

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

int	get_best_parent_from_Set (const std::set< int > &) const

int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...

bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly. More...

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type. More...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object. More...

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...

void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...

void	ref () const
	Explicitly increments the reference count. More...

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. More...

bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus. More...

bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...

virtual bool	unref () const
	Explicitly decrements the reference count. More...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object. More...

Static Public Member Functions
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from AudioSound
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedObject
static TypeHandle	get_class_type ()

static void	init_type ()
	This function is declared non-inline to work around a compiler bug in g++ 2.96. More...

Static Public Member Functions inherited from ReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Friends
class	OpenALAudioManager

Additional Inherited Members
Public Types inherited from AudioSound
enum	SoundStatus { BAD, READY, PLAYING }

Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count. More...

Detailed Description

Definition at line 32 of file openalAudioSound.h.

Member Function Documentation

◆ get_3d_attributes()

void OpenALAudioSound::get_3d_attributes	(	PN_stdfloat *	px,
		PN_stdfloat *	py,
		PN_stdfloat *	pz,
		PN_stdfloat *	vx,
		PN_stdfloat *	vy,
		PN_stdfloat *	vz
	)

virtual

Get position and velocity of this sound Currently unimplemented.

Get the attributes of the attached object.

Reimplemented from AudioSound.

Definition at line 706 of file openalAudioSound.cxx.

◆ get_3d_drop_off_factor()

PN_stdfloat OpenALAudioSound::get_3d_drop_off_factor ( ) const

Control the effect distance has on audability.

Defaults to 1.0

Definition at line 789 of file openalAudioSound.cxx.

◆ get_3d_max_distance()

PN_stdfloat OpenALAudioSound::get_3d_max_distance ( ) const

virtual

Get the distance that this sound stops falling off.

Reimplemented from AudioSound.

Definition at line 764 of file openalAudioSound.cxx.

◆ get_3d_min_distance()

PN_stdfloat OpenALAudioSound::get_3d_min_distance ( ) const

virtual

Get the distance that this sound begins to fall off.

Reimplemented from AudioSound.

Definition at line 739 of file openalAudioSound.cxx.

◆ get_active()

bool OpenALAudioSound::get_active ( ) const

virtual

Returns whether the sound has been marked "active".

Implements AudioSound.

Definition at line 831 of file openalAudioSound.cxx.

◆ get_balance()

PN_stdfloat OpenALAudioSound::get_balance ( ) const

virtual

-1.0 to 1.0 scale -1 should be all the way left.

1 is all the way to the right.

Implements AudioSound.

Definition at line 634 of file openalAudioSound.cxx.

◆ get_loop()

bool OpenALAudioSound::get_loop ( ) const

virtual

Returns whether looping is on or off.

Implements AudioSound.

Definition at line 253 of file openalAudioSound.cxx.

◆ get_loop_count()

unsigned long OpenALAudioSound::get_loop_count ( ) const

virtual

Return how many times a sound will loop.

Implements AudioSound.

Definition at line 276 of file openalAudioSound.cxx.

◆ get_name()

const std::string & OpenALAudioSound::get_name ( ) const

virtual

Get name of sound file.

Implements AudioSound.

Definition at line 855 of file openalAudioSound.cxx.

◆ get_time()

PN_stdfloat OpenALAudioSound::get_time ( ) const

virtual

Gets the play position within the sound.

Implements AudioSound.

Definition at line 570 of file openalAudioSound.cxx.

◆ get_volume()

PN_stdfloat OpenALAudioSound::get_volume ( ) const

virtual

Gets the current volume of a sound.

1 is Max. O is Min.

Implements AudioSound.

Definition at line 617 of file openalAudioSound.cxx.

◆ length()

PN_stdfloat OpenALAudioSound::length ( ) const

virtual

Get length.

Implements AudioSound.

Definition at line 665 of file openalAudioSound.cxx.

◆ play()

void OpenALAudioSound::play ( )

virtual

Plays a sound.

Implements AudioSound.

Definition at line 119 of file openalAudioSound.cxx.

References stop().

Referenced by set_active().

◆ set_3d_attributes()

void OpenALAudioSound::set_3d_attributes	(	PN_stdfloat	px,
		PN_stdfloat	py,
		PN_stdfloat	pz,
		PN_stdfloat	vx,
		PN_stdfloat	vy,
		PN_stdfloat	vz
	)

virtual

Set position and velocity of this sound.

Both Panda3D and OpenAL use a right handed coordinate system. However, in Panda3D the Y-Axis is going into the Screen and the Z-Axis is going up. In OpenAL the Y-Axis is going up and the Z-Axis is coming out of the screen.

The solution is simple, we just flip the Y and Z axis and negate the Z, as we move coordinates from Panda to OpenAL and back.

Reimplemented from AudioSound.

Definition at line 680 of file openalAudioSound.cxx.

◆ set_3d_drop_off_factor()

void OpenALAudioSound::set_3d_drop_off_factor ( PN_stdfloat factor )

Control the effect distance has on audability.

Defaults to 1.0

Definition at line 772 of file openalAudioSound.cxx.

◆ set_3d_max_distance()

void OpenALAudioSound::set_3d_max_distance ( PN_stdfloat dist )

virtual

Set the distance that this sound stops falling off.

Reimplemented from AudioSound.

Definition at line 747 of file openalAudioSound.cxx.

◆ set_3d_min_distance()

void OpenALAudioSound::set_3d_min_distance ( PN_stdfloat dist )

virtual

Set the distance that this sound begins to fall off.

Also affects the rate it falls off.

Reimplemented from AudioSound.

Definition at line 722 of file openalAudioSound.cxx.

◆ set_active()

void OpenALAudioSound::set_active ( bool active = true )

virtual

Sets whether the sound is marked "active".

By default, the active flag is true for all sounds. If the active flag is set to false for any particular sound, the sound will not be heard.

Implements AudioSound.

Definition at line 799 of file openalAudioSound.cxx.

References play(), status(), and stop().

◆ set_balance()

void OpenALAudioSound::set_balance ( PN_stdfloat balance_right = 0.0 )

virtual

-1.0 to 1.0 scale

Implements AudioSound.

Definition at line 625 of file openalAudioSound.cxx.

◆ set_loop()

void OpenALAudioSound::set_loop ( bool loop = true )

virtual

Turns looping on and off.

Implements AudioSound.

Definition at line 244 of file openalAudioSound.cxx.

◆ set_play_rate()

void OpenALAudioSound::set_play_rate ( PN_stdfloat play_rate = 1.0f )

virtual

Sets the speed at which a sound plays back.

The rate is a multiple of the sound, normal playback speed. IE 2 would play back 2 times fast, 3 would play 3 times, and so on.

Implements AudioSound.

Definition at line 645 of file openalAudioSound.cxx.

◆ set_time()

void OpenALAudioSound::set_time ( PN_stdfloat time = 0.0 )

virtual

The next time you call play, the sound will start from the specified offset.

Implements AudioSound.

Definition at line 561 of file openalAudioSound.cxx.

◆ set_volume()

void OpenALAudioSound::set_volume ( PN_stdfloat volume = 1.0 )

virtual

0.0 to 1.0 scale of volume converted to Fmod's internal 0.0 to 255.0 scale.

Implements AudioSound.

Definition at line 600 of file openalAudioSound.cxx.

◆ status()

AudioSound::SoundStatus OpenALAudioSound::status ( ) const

virtual

Get status of the sound.

This returns the status as of the last push_fresh_buffers

Implements AudioSound.

Definition at line 865 of file openalAudioSound.cxx.

Referenced by set_active().

◆ stop()

void OpenALAudioSound::stop ( )

virtual

Stop a sound.

Implements AudioSound.

Definition at line 196 of file openalAudioSound.cxx.

Referenced by play(), and set_active().

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

panda/src/audiotraits/openalAudioSound.h
panda/src/audiotraits/openalAudioSound.cxx
panda/src/audiotraits/openalAudioSound.I

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_3d_attributes()

◆ get_3d_drop_off_factor()

◆ get_3d_max_distance()

◆ get_3d_min_distance()

◆ get_active()

◆ get_balance()

◆ get_loop()

◆ get_loop_count()

◆ get_name()

◆ get_time()

◆ get_volume()

◆ length()

◆ play()

◆ set_3d_attributes()

◆ set_3d_drop_off_factor()

◆ set_3d_max_distance()

◆ set_3d_min_distance()

◆ set_active()

◆ set_balance()

◆ set_loop()

◆ set_play_rate()

◆ set_time()

◆ set_volume()

◆ status()

◆ stop()