Enum bevy_tween::tween::TargetComponent

pub enum TargetComponent {
    Marker,
    Entity(Entity),
    Entities(Vec<Entity>),
}

Tell the tween what component of what entity to tween.

Variants

Marker

Navigate up the parent chain for entity with AnimationTarget marker component

Entity(Entity)

Target this entity.

Entities(Vec<Entity>)

Target these entities.

Implementations

impl TargetComponent

pub fn marker() -> TargetComponent

Navigate up the parent chain for entity with AnimationTarget marker component

pub fn entity(entity: Entity) -> TargetComponent

Target this entity.

pub fn entities<I>(entities: I) -> TargetComponent

where I: IntoIterator<Item = Entity>,

Target these entities.

pub fn state<V>(&self, value: V) -> TargetState<Self, V>

Create a new TargetState with the initial value out of this target.

pub fn with<I>(&self, interpolator: I) -> Tween<Self, I>

Create a new tween with the supplied interpolator out of this target.

pub fn with_closure<F, C>( &self, closure: F, ) -> Tween<Self, Box<dyn Interpolator<Item = C>>>

where F: Fn(&mut C, f32) + Send + Sync + 'static, C: Component,

Create a new tween with the supplied closure out of this target.

Trait Implementations

impl Clone for TargetComponent

fn clone(&self) -> TargetComponent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TargetComponent

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

Formats the value using the given formatter.

impl Default for TargetComponent

fn default() -> Self

Returns the “default value” for a type.

impl Enum for TargetComponent

where Self: Any + Send + Sync, Entity: FromReflect + TypePath, Vec<Entity>: FromReflect + TypePath,

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

Returns a reference to the value of the field (in the current variant) with the given name.

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

Returns a reference to the value of the field (in the current variant) at the given index.

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

Returns a mutable reference to the value of the field (in the current variant) with the given name.

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

Returns a mutable reference to the value of the field (in the current variant) at the given index.

fn index_of(&self, __name_param: &str) -> Option<usize>

Returns the index of the field (in the current variant) with the given name.

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

Returns the name of the field (in the current variant) with the given index.

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

Returns an iterator over the values of the current variant’s fields.

fn field_len(&self) -> usize

Returns the number of fields in the current variant.

fn variant_name(&self) -> &str

The name of the current variant.

fn variant_index(&self) -> usize

The index of the current variant.

fn variant_type(&self) -> VariantType

The type of the current variant.

fn clone_dynamic(&self) -> DynamicEnum

fn is_variant(&self, variant_type: VariantType) -> bool

Returns true if the current variant’s type matches the given one.

fn variant_path(&self) -> String

Returns the full path to the current variant.

impl From<&[Entity]> for TargetComponent

fn from(value: &[Entity]) -> Self

Converts to this type from the input type.

impl<const N: usize> From<&[Entity; N]> for TargetComponent

fn from(value: &[Entity; N]) -> Self

Converts to this type from the input type.

impl From<&Vec<Entity>> for TargetComponent

fn from(value: &Vec<Entity>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[Entity; N]> for TargetComponent

fn from(value: [Entity; N]) -> Self

Converts to this type from the input type.

impl From<Entity> for TargetComponent

fn from(value: Entity) -> Self

Converts to this type from the input type.

impl From<Vec<Entity>> for TargetComponent

fn from(value: Vec<Entity>) -> Self

Converts to this type from the input type.

impl FromIterator<Entity> for TargetComponent

fn from_iter<T: IntoIterator<Item = Entity>>(iter: T) -> Self

Creates a value from an iterator.

impl FromReflect for TargetComponent

where Self: Any + Send + Sync, Entity: FromReflect + TypePath, Vec<Entity>: FromReflect + TypePath,

fn from_reflect(__param0: &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 TargetComponent

where Self: Any + Send + Sync, Entity: FromReflect + TypePath, Vec<Entity>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Hash for TargetComponent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TargetComponent

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for TargetComponent

where Self: Any + Send + Sync, Entity: FromReflect + TypePath, Vec<Entity>: 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_param: Box<dyn Reflect>, ) -> Result<(), Box<dyn Reflect>>

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

fn apply(&mut self, __value_param: &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_hash(&self) -> Option<u64>

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

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

Returns a “partial equality” comparison result.

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 TransformTargetStateExt for TargetComponent

fn transform_state(&self, value: Transform) -> TransformTargetState

Create TransformTargetState from TargetComponent and initial value

Examples

let my_target = sprite.into_target();
let mut my_target_translation = my_target.transform_state(Transform::IDENTITY);

// Creating a ComponentTween that's tweening from previous translation to Vec3::ONE
let tween = my_target_translation.translation_to(Vec3::ONE);

impl TypePath for TargetComponent

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 TargetComponent

where Self: Any + Send + Sync, Entity: FromReflect + TypePath, Vec<Entity>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for TargetComponent

impl StructuralPartialEq for TargetComponent