Enum DistanceModel 

#[repr(u32)]
pub enum DistanceModel {
    None = 0,
    InverseDistance = 1,
    LinearDistance = 2,
    ExponentDistance = 3,
}

Distance model defines how volume of sound will decay when distance to listener changes.

Variants

None = 0

No distance attenuation at all.

InverseDistance = 1

Distance will decay using following formula:

clamped_distance = min(max(distance, radius), max_distance) attenuation = radius / (radius + rolloff_factor * (clamped_distance - radius))

where - radius - of source at which it has maximum volume, max_distance - distance at which decay will stop, rolloff_factor - coefficient that defines how fast volume will decay

Notes

This is default distance model of context.

LinearDistance = 2

Distance will decay using following formula:

clamped_distance = min(max(distance, radius), max_distance) attenuation = 1.0 - radius * (clamped_distance - radius) / (max_distance - radius)

where - radius - of source at which it has maximum volume, max_distance - distance at which decay will stop

Notes

As you can see rolloff_factor is ignored here because of linear law.

ExponentDistance = 3

Distance will decay using following formula:

clamped_distance = min(max(distance, radius), max_distance) (clamped_distance / radius) ^ (-rolloff_factor)

where - radius - of source at which it has maximum volume, max_distance - distance at which decay will stop, rolloff_factor - coefficient that defines how fast volume will decay

Trait Implementations

impl AsRef<str> for DistanceModel

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for DistanceModel

fn clone(&self) -> DistanceModel

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DistanceModel

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for DistanceModel

fn default() -> DistanceModel

Returns the “default value” for a type.

impl FromStr for DistanceModel

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<DistanceModel, <DistanceModel as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for DistanceModel

fn eq(&self, other: &DistanceModel) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for DistanceModel

where DistanceModel: 'static,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<DistanceModel>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]), )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>), )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl TryFrom<&str> for DistanceModel

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<DistanceModel, <DistanceModel as TryFrom<&str>>::Error>

Performs the conversion.

impl TypeUuidProvider for DistanceModel

fn type_uuid() -> Uuid

Return type UUID.

impl VariantNames for DistanceModel

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl Visit for DistanceModel

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl Copy for DistanceModel

impl Eq for DistanceModel

impl StructuralPartialEq for DistanceModel