Struct bevy_particle_systems::values::JitteredValue

pub struct JitteredValue {
    pub value: f32,
    pub jitter_range: Option<Range<f32>>,
}

A value that has random jitter within a configured range added to it when read.

Ranges can include negative values as well to return values below the specified base value.

Generated jitter will be distributed uniformly across the range over time.

Examples

The following code returns a constant value.

let mut rng = rand::thread_rng();
let jittered_value: JitteredValue = 5.0.into();
for _ in 0..10 {
    // The rng will not be invoked for constant values.
    let value = jittered_value.get_value(&mut rng);
    assert_eq!(value, 5.0);
}

The following example would have get_value return values betten 5.0 and 15.0.

let mut rng = rand::thread_rng();
let jittered_value = JitteredValue::jittered(10.0, -5.0..5.0);
for _ in 0..10 {
    let value = jittered_value.get_value(&mut rng);
    assert!(value < 15.0);
    assert!(value >= 5.0);
}

Fields

value: f32

The base value that specified jitter will be added to.

jitter_range: Option<Range<f32>>

A Range of possible random jitter to be added to value at evaluation time.

jitter_range start value can be negative to allow some values to be less than the base as well.

Implementations

impl JitteredValue

pub const fn new(f: f32) -> Self

Create a new value with no jitter.

pub const fn jittered(f: f32, jitter_range: Range<f32>) -> Self

Create a new value with a jitter range.

pub fn centered_range(range: Range<f32>) -> Self

Create a new JitteredValue with a value centered within the jitter range.

pub const fn with_jitter(&self, jitter_range: Range<f32>) -> Self

Create a new JitteredValue from an existing one with the specified jitter range.

pub fn get_value(&self, rng: &mut ThreadRng) -> f32

Get a value with random jitter within jitter_range added to it.

Trait Implementations

impl Clone for JitteredValue

fn clone(&self) -> JitteredValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JitteredValue

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

Formats the value using the given formatter.

impl From<Range<f32>> for JitteredValue

fn from(range: Range<f32>) -> Self

Converts to this type from the input type.

impl From<f32> for JitteredValue

fn from(f: f32) -> Self

Converts to this type from the input type.

impl FromReflect for JitteredValue

where Self: Any + Send + Sync, f32: FromReflect + TypePath, Option<Range<f32>>: FromReflect + TypePath,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for JitteredValue

where Self: Any + Send + Sync, f32: FromReflect + TypePath, Option<Range<f32>>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for JitteredValue

where Self: Any + Send + Sync, f32: FromReflect + TypePath, Option<Range<f32>>: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

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 reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

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

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

fn apply(&mut self, value: &dyn Reflect)

Applies 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 reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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 serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for JitteredValue

where Self: Any + Send + Sync, f32: FromReflect + TypePath, Option<Range<f32>>: FromReflect + TypePath,

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

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

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

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

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

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

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

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

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for JitteredValue

where Self: Any + Send + Sync,

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 JitteredValue

where Self: Any + Send + Sync, f32: FromReflect + TypePath, Option<Range<f32>>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.