Skip to main content

DistanceModel

Enum DistanceModel 

pub enum DistanceModel {
    Inverse {
        ref_distance: f32,
        max_distance: f32,
        rolloff_factor: f32,
    },
    Linear {
        ref_distance: f32,
        max_distance: f32,
        rolloff_factor: f32,
    },
    Exponential {
        ref_distance: f32,
        max_distance: f32,
        rolloff_factor: f32,
    },
}
Expand description

Distance attenuation model.

Variants§

§

Inverse

Inverse distance falloff: gain = ref_dist / (ref_dist + rolloff * (dist - ref_dist)).

Fields

§ref_distance: f32
§max_distance: f32
§rolloff_factor: f32
§

Linear

Linear distance falloff: gain = 1 - rolloff * (dist - ref_dist) / (max_dist - ref_dist).

Fields

§ref_distance: f32
§max_distance: f32
§rolloff_factor: f32
§

Exponential

Exponential distance falloff: gain = (dist / ref_dist)^(-rolloff).

Fields

§ref_distance: f32
§max_distance: f32
§rolloff_factor: f32

Implementations§

§

impl DistanceModel

pub fn calculate_gain(&self, distance: f32) -> f32

Calculates distance attenuation gain in range [0.0, 1.0].

Trait Implementations§

§

impl Clone for DistanceModel

§

fn clone(&self) -> DistanceModel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Copy for DistanceModel

§

impl Debug for DistanceModel

§

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

Formats the value using the given formatter. Read more
§

impl Default for DistanceModel

§

fn default() -> DistanceModel

Returns the “default value” for a type. Read more
§

impl PartialEq for DistanceModel

§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl StructuralPartialEq for DistanceModel

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.