Applies a scale to audio volume for positional sounds in the scene graph. More...

#include "audioVolumeAttrib.h"

Inheritance diagram for AudioVolumeAttrib:

Public Member Functions
virtual TypeHandle	force_init_type ()

virtual int	get_slot () const

virtual TypeHandle	get_type () const

PN_stdfloat	get_volume () const

bool	has_volume () const

bool	is_off () const
	Returns true if the AudioVolumeAttrib will ignore any color scales inherited from above, false otherwise.

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

ConstPointerTo< RenderAttrib >	set_volume (PN_stdfloat volume) const
	Returns a new AudioVolumeAttrib, just like this one, but with the volume changed to the indicated value.

virtual void	write_datagram (BamWriter *manager, Datagram &dg)
	Writes the contents of this object to the datagram for shipping out to a Bam file.

Public Member Functions inherited from RenderAttrib
	RenderAttrib (const RenderAttrib &copy)=delete

virtual	~RenderAttrib ()
	The destructor is responsible for removing the RenderAttrib from the global set if it is there.

int	compare_to (const RenderAttrib &other) const

	CPT (RenderAttrib) compose(const RenderAttrib *other) const

	CPT (RenderAttrib) get_unique() const

	CPT (RenderAttrib) invert_compose(const RenderAttrib *other) const

virtual bool	cull_callback (CullTraverser *trav, const CullTraverserData &data) const
	If has_cull_callback() returns true, this function will be called during the cull traversal to perform any additional operations that should be performed at cull time.

virtual void	finalize (BamReader *manager)
	Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.

size_t	get_hash () const

virtual bool	has_cull_callback () const
	Should be overridden by derived classes to return true if cull_callback() has been defined.

virtual bool	lower_attrib_can_override () const
	Intended to be overridden by derived RenderAttrib types to specify how two consecutive RenderAttrib objects of the same type interact.

RenderAttrib &	operator= (const RenderAttrib &copy)=delete

virtual bool	unref () const final
	This method overrides ReferenceCount::unref() to clear the pointer from the global object pool when its reference count goes to zero.

virtual void	write (std::ostream &out, int indent_level) const

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

virtual ReferenceCount *	as_reference_count ()
	Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.

void	operator= (const TypedWritableReferenceCount &copy)

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

virtual int	complete_pointers (TypedWritable *p_list, BamReader manager)
	Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

vector_uchar	encode_to_bam_stream () const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object.

bool	encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
	Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.

UpdateSeq	get_bam_modified () const
	Returns the current bam_modified counter.

void	mark_bam_modified ()
	Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.

void	operator= (const TypedWritable &copy)

virtual bool	require_fully_complete () const
	Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.

virtual void	update_bam_nested (BamWriter *manager)
	Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.

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.

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

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.

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

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

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

Public Member Functions inherited from MemoryBase
void	operator delete (void , void )

void	operator delete (void *ptr)

void	operator delete[] (void , void )

void	operator delete[] (void *ptr)

void *	operator new (size_t size)

void *	operator new (size_t size, void *ptr)

void *	operator new[] (size_t size)

void *	operator new[] (size_t size, void *ptr)

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

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

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

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

void	ref () const
	Explicitly increments the reference count.

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

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

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

bool	unref_if_one () const
	Atomically decreases the reference count of this object if it is one.

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

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

Static Public Member Functions
static int	get_class_slot ()

static TypeHandle	get_class_type ()

static void	init_type ()

static ConstPointerTo< RenderAttrib >	make (PN_stdfloat volume)
	Constructs a new AudioVolumeAttrib object that indicates audio volume should be scaled by the indicated factor.

static ConstPointerTo< RenderAttrib >	make_default ()
	Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.

static ConstPointerTo< RenderAttrib >	make_identity ()
	Constructs an identity audio volume attrib.

static ConstPointerTo< RenderAttrib >	make_off ()
	Constructs a new AudioVolumeAttrib object that ignores any AudioVolumeAttrib inherited from above.

static void	register_with_read_factory ()
	Tells the BamReader how to create objects of type AudioVolumeAttrib.

Static Public Member Functions inherited from RenderAttrib
static TypedWritable *	change_this (TypedWritable old_ptr, BamReader manager)
	Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired.

static int	garbage_collect ()
	Performs a garbage-collection cycle.

static TypeHandle	get_class_type ()

static int	get_num_attribs ()
	Returns the total number of unique RenderAttrib objects allocated in the world.

static void	init_attribs ()
	Make sure the global _attribs map is allocated.

static void	init_type ()

static void	list_attribs (std::ostream &out)
	Lists all of the RenderAttribs in the cache to the output stream, one per line.

static int	register_slot (TypeHandle type_handle, int sort, RenderAttrib *default_attrib)
	Adds the indicated TypeHandle to the registry, if it is not there already, and returns a unique slot number.

static bool	validate_attribs ()
	Ensures that the cache is still stored in sorted order.

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

static void	init_type ()

static	PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data

Static Public Member Functions inherited from TypedWritable
static bool	decode_raw_from_bam_stream (TypedWritable &ptr, ReferenceCount &ref_ptr, vector_uchar data, BamReader *reader=nullptr)
	Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes.

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.

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

static void	init_type ()

Public Attributes
	get_class_slot

	get_volume
	Returns the volume to be applied to sounds.

	has_volume
	Returns true if the AudioVolumeAttrib has a non-identity volume, false otherwise (in which case it might be an off attrib or an identity attrib).

Public Attributes inherited from RenderAttrib
	get_slot

Public Attributes inherited from TypedWritableReferenceCount
static BamReader *	reader = nullptr)

Public Attributes inherited from TypedObject
	get_type

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

Additional Inherited Members
Public Types inherited from RenderAttrib
enum	PandaCompareFunc { M_none =0 , M_never , M_less , M_equal , M_less_equal , M_greater , M_not_equal , M_greater_equal , M_always }

enum	TexGenMode { M_off , M_eye_sphere_map , M_world_cube_map , M_eye_cube_map , M_world_normal , M_eye_normal , M_world_position , M_unused , M_eye_position , M_point_sprite , M_unused2 , M_constant }

Static Public Attributes inherited from TypedWritable
static TypedWritable *const	Null = nullptr

Detailed Description

Applies a scale to audio volume for positional sounds in the scene graph.

Definition at line 27 of file audioVolumeAttrib.h.

Member Function Documentation

◆ force_init_type()

virtual TypeHandle AudioVolumeAttrib::force_init_type ( )

inlinevirtual

Reimplemented from RenderAttrib.

Definition at line 91 of file audioVolumeAttrib.h.

◆ get_class_slot()

static int AudioVolumeAttrib::get_class_slot ( )

inlinestatic

Definition at line 62 of file audioVolumeAttrib.h.

◆ get_class_type()

static TypeHandle AudioVolumeAttrib::get_class_type ( )

inlinestatic

Definition at line 79 of file audioVolumeAttrib.h.

◆ get_slot()

virtual int AudioVolumeAttrib::get_slot ( ) const

inlinevirtual

Implements RenderAttrib.

Definition at line 65 of file audioVolumeAttrib.h.

◆ get_type()

virtual TypeHandle AudioVolumeAttrib::get_type ( ) const

inlinevirtual

Reimplemented from RenderAttrib.

Definition at line 88 of file audioVolumeAttrib.h.

◆ init_type()

static void AudioVolumeAttrib::init_type ( )

inlinestatic

Definition at line 82 of file audioVolumeAttrib.h.

◆ is_off()

bool AudioVolumeAttrib::is_off ( ) const

inline

Returns true if the AudioVolumeAttrib will ignore any color scales inherited from above, false otherwise.

This is not the same thing as !has_scale(); a AudioVolumeAttrib may have the "off" flag set and also have another scale specified.

Definition at line 31 of file audioVolumeAttrib.I.

◆ make()

ConstPointerTo< RenderAttrib > AudioVolumeAttrib::make ( PN_stdfloat volume )

static

Constructs a new AudioVolumeAttrib object that indicates audio volume should be scaled by the indicated factor.

Definition at line 58 of file audioVolumeAttrib.cxx.

Referenced by NodePath::set_audio_volume().

◆ make_default()

ConstPointerTo< RenderAttrib > AudioVolumeAttrib::make_default ( )

static

Returns a RenderAttrib that corresponds to whatever the standard default properties for render attributes of this type ought to be.

Definition at line 80 of file audioVolumeAttrib.cxx.

◆ make_identity()

ConstPointerTo< RenderAttrib > AudioVolumeAttrib::make_identity ( )

static

Constructs an identity audio volume attrib.

Definition at line 42 of file audioVolumeAttrib.cxx.

◆ make_off()

ConstPointerTo< RenderAttrib > AudioVolumeAttrib::make_off ( )

static

Constructs a new AudioVolumeAttrib object that ignores any AudioVolumeAttrib inherited from above.

You may also specify an additional volume scale to apply to geometry below (using set_volume()).

Definition at line 69 of file audioVolumeAttrib.cxx.

Referenced by NodePath::set_audio_volume_off().

◆ output()

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

virtual

Reimplemented from RenderAttrib.

Definition at line 101 of file audioVolumeAttrib.cxx.

◆ register_with_read_factory()

void AudioVolumeAttrib::register_with_read_factory ( )

static

Tells the BamReader how to create objects of type AudioVolumeAttrib.

Definition at line 201 of file audioVolumeAttrib.cxx.

References BamReader::get_factory(), and Factory< Type >::register_factory().

Referenced by init_libpgraph().

◆ set_volume()

ConstPointerTo< RenderAttrib > AudioVolumeAttrib::set_volume ( PN_stdfloat volume ) const

Returns a new AudioVolumeAttrib, just like this one, but with the volume changed to the indicated value.

Definition at line 89 of file audioVolumeAttrib.cxx.

◆ write_datagram()

void AudioVolumeAttrib::write_datagram	(	BamWriter *	manager,
		Datagram &	dg )

virtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from RenderAttrib.

Definition at line 210 of file audioVolumeAttrib.cxx.

References Datagram::add_bool(), Datagram::add_stdfloat(), and RenderAttrib::write_datagram().

Member Data Documentation

◆ get_class_slot

AudioVolumeAttrib::get_class_slot

Definition at line 68 of file audioVolumeAttrib.h.

◆ get_volume

PN_stdfloat AudioVolumeAttrib::get_volume

inline

Returns the volume to be applied to sounds.

Definition at line 44 of file audioVolumeAttrib.h.

Referenced by NodePath::get_audio_volume(), and NodePath::get_net_audio_volume().

◆ has_volume

bool AudioVolumeAttrib::has_volume

inline

Returns true if the AudioVolumeAttrib has a non-identity volume, false otherwise (in which case it might be an off attrib or an identity attrib).

Definition at line 44 of file audioVolumeAttrib.h.

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

panda/src/pgraph/audioVolumeAttrib.h
panda/src/pgraph/audioVolumeAttrib.cxx
panda/src/pgraph/audioVolumeAttrib.I

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ force_init_type()

◆ get_class_slot()

◆ get_class_type()

◆ get_slot()

◆ get_type()

◆ init_type()

◆ is_off()

◆ make()

◆ make_default()

◆ make_identity()

◆ make_off()

◆ output()

◆ register_with_read_factory()

◆ set_volume()

◆ write_datagram()

Member Data Documentation

◆ get_class_slot

◆ get_volume

◆ has_volume