Struct SpatialBasicNode 

pub struct SpatialBasicNode {
    pub volume: Volume,
    pub offset: Vec3,
    pub panning_threshold: f32,
    pub downmix: bool,
    pub muffle_cutoff_hz: f32,
    pub distance_attenuation: DistanceAttenuation,
    pub smooth_seconds: f32,
    pub min_gain: f32,
    pub coeff_update_factor: CoeffUpdateFactor,
}

A 3D spatial positioning node using a basic but fast algorithm. It does not make use of any fancy binaural algorithms, rather it just applies basic panning and filtering.

Fields

volume: Volume

The overall volume. This is applied before the spatialization algorithm.

offset: Vec3

A 3D vector representing the offset between the listener and the sound source.

The coordinates are (x, y, z).

• -x is to the left of the listener, and +x is the the right of the listener
• -y is below the listener, and +y is above the listener.
• -z is in front of the listener, and +z is behind the listener

By default this is set to (0.0, 0.0, 0.0)

panning_threshold: f32

The threshold for the maximum amount of panning that can occur, in the range [0.0, 1.0], where 0.0 is no panning and 1.0 is full panning (where one of the channels is fully silent when panned hard left or right).

Setting this to a value less than 1.0 can help remove some of the jarringness of having a sound playing in only one ear.

By default this is set to 0.6.

downmix: bool

If true, then any stereo input signals will be downmixed to mono before going throught the spatialization algorithm. If false then the left and right channels will be processed independently.

This has no effect if only one input channel is connected.

By default this is set to true.

muffle_cutoff_hz: f32

The amount of muffling (lowpass) in the range [20.0, 20_480.0], where 20_480.0 is no muffling and 20.0 is maximum muffling.

This can be used to give the effect of a sound being played behind a wall or underwater.

By default this is set to 20_480.0.

See https://www.desmos.com/calculator/jxp8t9ero4 for an interactive graph of how these parameters affect the final lowpass cuttoff frequency.

distance_attenuation: DistanceAttenuation

The parameters which describe how to attenuate a sound based on its distance from the listener.

smooth_seconds: f32

The time in seconds of the internal smoothing filter.

By default this is set to 0.015 (15ms).

min_gain: f32

If the resutling gain (in raw amplitude, not decibels) is less than or equal to this value, the the gain will be clamped to 0 (silence).

By default this is set to “0.0001” (-80 dB).

coeff_update_factor: CoeffUpdateFactor

An exponent representing the rate at which DSP coefficients are updated when parameters are being smoothed.

Smaller values will produce less “stair-stepping” artifacts, but will also consume more CPU.

The resulting number of frames (samples in a single channel of audio) that will elapse between each update is calculated as 2^coeff_update_factor.

By default this is set to 5.

Implementations

impl SpatialBasicNode

pub fn from_volume_offset(volume: Volume, offset: impl Into<Vec3>) -> Self

pub const fn set_volume_linear(&mut self, linear: f32)

Set the given volume in a linear scale, where 0.0 is silence and 1.0 is unity gain.

These units are suitable for volume sliders (simply convert percent volume to linear volume by diving the percent volume by 100).

pub const fn set_volume_percent(&mut self, percent: f32)

Set the given volume in percentage, where 0.0 is silence and 100.0 is unity gain.

These units are suitable for volume sliders.

pub const fn set_volume_decibels(&mut self, decibels: f32)

Set the given volume in decibels, where 0.0 is unity gain and f32::NEG_INFINITY is silence.

Trait Implementations

impl AudioNode for SpatialBasicNode

type Configuration = EmptyConfig

A type representing this constructor’s configuration.

fn info(&self, _config: &Self::Configuration) -> AudioNodeInfo

Get information about this node.

fn construct_processor( &self, _config: &Self::Configuration, cx: ConstructProcessorContext<'_>, ) -> impl AudioNodeProcessor

Construct a realtime processor for this node.

fn update(&mut self, configuration: &Self::Configuration, cx: UpdateContext<'_>)

If AudioNodeInfo::call_update_method was set to true, then the Firewheel context will call this method on every update cycle.

impl Clone for SpatialBasicNode

fn clone(&self) -> SpatialBasicNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for SpatialBasicNode

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for SpatialBasicNode

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

Formats the value using the given formatter.

impl Default for SpatialBasicNode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpatialBasicNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Diff for SpatialBasicNode

where Volume: Diff, Vec3: Diff, f32: Diff, bool: Diff, DistanceAttenuation: Diff, CoeffUpdateFactor: Diff,

fn diff<__E: EventQueue>( &self, baseline: &Self, path: PathBuilder, event_queue: &mut __E, )

Compare self to baseline and generate events to resolve any differences.

impl FromReflect for SpatialBasicNode

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for SpatialBasicNode

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialEq for SpatialBasicNode

fn eq(&self, other: &SpatialBasicNode) -> 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 PartialReflect for SpatialBasicNode

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Patch for SpatialBasicNode

where Volume: Patch, Vec3: Patch, f32: Patch, bool: Patch, DistanceAttenuation: Patch, CoeffUpdateFactor: Patch,

type Patch = SpatialBasicNodePatch

A type’s patch.

fn patch(data: &ParamData, path: &[u32]) -> Result<Self::Patch, PatchError>

Construct a patch from a parameter event.

fn apply(&mut self, patch: Self::Patch)

Apply a patch.

fn patch_event(event: &NodeEventType) -> Option<Self::Patch>

Construct a patch from a node event.

impl Reflect for SpatialBasicNode

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

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

Performs a type-checked assignment of a reflected value to this value.

impl Serialize for SpatialBasicNode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for SpatialBasicNode

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for SpatialBasicNode

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for SpatialBasicNode

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for SpatialBasicNode

impl StructuralPartialEq for SpatialBasicNode