AudioVolumeAttrib

from acron.core import AudioVolumeAttrib

class AudioVolumeAttrib

Bases:

Bases: RenderAttrib

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

Inheritance diagram

digraph inheritance1c37674b3f { bgcolor=transparent; rankdir=BT; size="8.0, 12.0"; "AudioVolumeAttrib" [URL="acron.core.AudioVolumeAttrib.html#acron.core.AudioVolumeAttrib",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "RenderAttrib" -> "AudioVolumeAttrib" [arrowsize=0.75,style=""]; "DTOOL_SUPER_BASE" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style=""]; "ReferenceCount" [URL="acron.core.ReferenceCount.html#acron.core.ReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "ReferenceCount" [arrowsize=0.75,style=""]; "RenderAttrib" [URL="acron.core.RenderAttrib.html#acron.core.RenderAttrib",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedWritableReferenceCount" -> "RenderAttrib" [arrowsize=0.75,style=""]; "TypedObject" [URL="acron.core.TypedObject.html#acron.core.TypedObject",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "DTOOL_SUPER_BASE" -> "TypedObject" [arrowsize=0.75,style=""]; "TypedWritable" [URL="acron.core.TypedWritable.html#acron.core.TypedWritable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedObject" -> "TypedWritable" [arrowsize=0.75,style=""]; "TypedWritableReferenceCount" [URL="acron.core.TypedWritableReferenceCount.html#acron.core.TypedWritableReferenceCount",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=11,height=0.25,shape=box,style="",target="_top",tooltip="/**"]; "TypedWritable" -> "TypedWritableReferenceCount" [arrowsize=0.75,style=""]; "ReferenceCount" -> "TypedWritableReferenceCount" [arrowsize=0.75,style=""]; }

property class_slot → int

static get_class_slot()

static get_class_type()

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).

is_off()

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.

static make()

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

static make_default()

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

static make_identity()

Constructs an identity audio volume attrib.

static make_off()

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()).

set_volume()

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

property volume → float

Returns the volume to be applied to sounds.