Struct AnimatedField 

pub struct AnimatedField<C, A, F>
where
    F: Fn(&mut C) -> &mut A,
{ /* private fields */ }

A Component field that can be animated, defined by a function that reads the component and returns the accessed field / property.

The best way to create an instance of this type is via the animated_field macro.

C is the component being animated, A is the type of the Animatable field on the component, and F is an accessor function that accepts a reference to C and retrieves the field A.

Implementations

impl<C, P, F> AnimatedField<C, P, F>

where C: Typed, F: Fn(&mut C) -> &mut P + 'static,

pub fn new_unchecked(field_name: &str, func: F) -> AnimatedField<C, P, F>

Creates a new instance of AnimatedField. This operates under the assumption that C is a reflect-able struct, and that field_name is a valid field on that struct.

Panics

If the type of C is not a struct or if the field_name does not exist.

Trait Implementations

impl<C, A, F> AnimatableProperty for AnimatedField<C, A, F>

where C: Component<Mutability = Mutable>, A: Animatable + Clone + Sync + Debug, F: Fn(&mut C) -> &mut A + Send + Sync + 'static,

type Property = A

The animated property type.

fn get_mut<'a>( &self, entity: &'a mut EntityMutExcept<'_, (AnimationTarget, AnimationPlayer, AnimationGraphHandle)>, ) -> Result<&'a mut A, AnimationEvaluationError>

Retrieves the property from the given entity.

fn evaluator_id(&self) -> EvaluatorId<'_>

The EvaluatorId used to look up the AnimationCurveEvaluator for this AnimatableProperty. For a given animated property, this ID should always be the same to allow things like animation blending to occur.

impl<C, A, F> Clone for AnimatedField<C, A, F>

where C: Clone, A: Clone, F: Clone + Fn(&mut C) -> &mut A,

fn clone(&self) -> AnimatedField<C, A, F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.