Struct AnimationTransitions

Source
pub struct AnimationTransitions { /* private fields */ }
Expand description

Manages fade-out of animation blend factors, allowing for smooth transitions between animations.

To use this component, place it on the same entity as the AnimationPlayer and AnimationGraphHandle. It’ll take responsibility for adjusting the weight on the ActiveAnimation in order to fade out animations smoothly.

When using an AnimationTransitions component, you should play all animations through the AnimationTransitions::play method, rather than by directly manipulating the AnimationPlayer. Playing animations through the AnimationPlayer directly will cause the AnimationTransitions component to get confused about which animation is the “main” animation, and transitions will usually be incorrect as a result.

Implementations§

Source§

impl AnimationTransitions

Source

pub fn new() -> AnimationTransitions

Creates a new AnimationTransitions component, ready to be added to an entity with an AnimationPlayer.

Examples found in repository?
examples/stress_tests/many_foxes.rs (line 244)
232fn setup_scene_once_loaded(
233    animations: Res<Animations>,
234    foxes: Res<Foxes>,
235    mut commands: Commands,
236    mut player: Query<(Entity, &mut AnimationPlayer)>,
237    mut done: Local<bool>,
238) {
239    if !*done && player.iter().len() == foxes.count {
240        for (entity, mut player) in &mut player {
241            commands
242                .entity(entity)
243                .insert(AnimationGraphHandle(animations.graph.clone()))
244                .insert(AnimationTransitions::new());
245
246            let playing_animation = player.play(animations.node_indices[0]).repeat();
247            if !foxes.sync {
248                playing_animation.seek_to(entity.index() as f32 / 10.0);
249            }
250        }
251        *done = true;
252    }
253}
More examples
Hide additional examples
examples/testbed/3d.rs (line 291)
282    fn pause_animation_frame(
283        trigger: Trigger<SceneInstanceReady>,
284        children: Query<&Children>,
285        mut commands: Commands,
286        animation: Res<Animation>,
287        mut players: Query<(Entity, &mut AnimationPlayer)>,
288    ) {
289        for child in children.iter_descendants(trigger.target()) {
290            if let Ok((entity, mut player)) = players.get_mut(child) {
291                let mut transitions = AnimationTransitions::new();
292                transitions
293                    .play(&mut player, animation.animation, Duration::ZERO)
294                    .seek_to(0.5)
295                    .pause();
296
297                commands
298                    .entity(entity)
299                    .insert(AnimationGraphHandle(animation.graph.clone()))
300                    .insert(transitions);
301            }
302        }
303    }
examples/animation/animated_mesh_control.rs (line 111)
105fn setup_scene_once_loaded(
106    mut commands: Commands,
107    animations: Res<Animations>,
108    mut players: Query<(Entity, &mut AnimationPlayer), Added<AnimationPlayer>>,
109) {
110    for (entity, mut player) in &mut players {
111        let mut transitions = AnimationTransitions::new();
112
113        // Make sure to start the animation via the `AnimationTransitions`
114        // component. The `AnimationTransitions` component wants to manage all
115        // the animations and will get confused if the animations are started
116        // directly via the `AnimationPlayer`.
117        transitions
118            .play(&mut player, animations.animations[0], Duration::ZERO)
119            .repeat();
120
121        commands
122            .entity(entity)
123            .insert(AnimationGraphHandle(animations.graph_handle.clone()))
124            .insert(transitions);
125    }
126}
examples/animation/animated_mesh_events.rs (line 174)
137fn setup_scene_once_loaded(
138    mut commands: Commands,
139    animations: Res<Animations>,
140    feet: Res<FoxFeetTargets>,
141    graphs: Res<Assets<AnimationGraph>>,
142    mut clips: ResMut<Assets<AnimationClip>>,
143    mut players: Query<(Entity, &mut AnimationPlayer), Added<AnimationPlayer>>,
144) {
145    fn get_clip<'a>(
146        node: AnimationNodeIndex,
147        graph: &AnimationGraph,
148        clips: &'a mut Assets<AnimationClip>,
149    ) -> &'a mut AnimationClip {
150        let node = graph.get(node).unwrap();
151        let clip = match &node.node_type {
152            AnimationNodeType::Clip(handle) => clips.get_mut(handle),
153            _ => unreachable!(),
154        };
155        clip.unwrap()
156    }
157
158    for (entity, mut player) in &mut players {
159        // Send `OnStep` events once the fox feet hits the ground in the running animation.
160
161        let graph = graphs.get(&animations.graph_handle).unwrap();
162        let running_animation = get_clip(animations.index, graph, &mut clips);
163
164        // You can determine the time an event should trigger if you know witch frame it occurs and
165        // the frame rate of the animation. Let's say we want to trigger an event at frame 15,
166        // and the animation has a frame rate of 24 fps, then time = 15 / 24 = 0.625.
167        running_animation.add_event_to_target(feet.front_left, 0.625, OnStep);
168        running_animation.add_event_to_target(feet.front_right, 0.5, OnStep);
169        running_animation.add_event_to_target(feet.back_left, 0.0, OnStep);
170        running_animation.add_event_to_target(feet.back_right, 0.125, OnStep);
171
172        // Start the animation
173
174        let mut transitions = AnimationTransitions::new();
175
176        // Make sure to start the animation via the `AnimationTransitions`
177        // component. The `AnimationTransitions` component wants to manage all
178        // the animations and will get confused if the animations are started
179        // directly via the `AnimationPlayer`.
180        transitions
181            .play(&mut player, animations.index, Duration::ZERO)
182            .repeat();
183
184        commands
185            .entity(entity)
186            .insert(AnimationGraphHandle(animations.graph_handle.clone()))
187            .insert(transitions);
188    }
189}
Source

pub fn play<'p>( &mut self, player: &'p mut AnimationPlayer, new_animation: NodeIndex, transition_duration: Duration, ) -> &'p mut ActiveAnimation

Plays a new animation on the given AnimationPlayer, fading out any existing animations that were already playing over the transition_duration.

Pass Duration::ZERO to instantly switch to a new animation, avoiding any transition.

Examples found in repository?
examples/testbed/3d.rs (line 293)
282    fn pause_animation_frame(
283        trigger: Trigger<SceneInstanceReady>,
284        children: Query<&Children>,
285        mut commands: Commands,
286        animation: Res<Animation>,
287        mut players: Query<(Entity, &mut AnimationPlayer)>,
288    ) {
289        for child in children.iter_descendants(trigger.target()) {
290            if let Ok((entity, mut player)) = players.get_mut(child) {
291                let mut transitions = AnimationTransitions::new();
292                transitions
293                    .play(&mut player, animation.animation, Duration::ZERO)
294                    .seek_to(0.5)
295                    .pause();
296
297                commands
298                    .entity(entity)
299                    .insert(AnimationGraphHandle(animation.graph.clone()))
300                    .insert(transitions);
301            }
302        }
303    }
More examples
Hide additional examples
examples/animation/animated_mesh_control.rs (line 118)
105fn setup_scene_once_loaded(
106    mut commands: Commands,
107    animations: Res<Animations>,
108    mut players: Query<(Entity, &mut AnimationPlayer), Added<AnimationPlayer>>,
109) {
110    for (entity, mut player) in &mut players {
111        let mut transitions = AnimationTransitions::new();
112
113        // Make sure to start the animation via the `AnimationTransitions`
114        // component. The `AnimationTransitions` component wants to manage all
115        // the animations and will get confused if the animations are started
116        // directly via the `AnimationPlayer`.
117        transitions
118            .play(&mut player, animations.animations[0], Duration::ZERO)
119            .repeat();
120
121        commands
122            .entity(entity)
123            .insert(AnimationGraphHandle(animations.graph_handle.clone()))
124            .insert(transitions);
125    }
126}
127
128fn keyboard_control(
129    keyboard_input: Res<ButtonInput<KeyCode>>,
130    mut animation_players: Query<(&mut AnimationPlayer, &mut AnimationTransitions)>,
131    animations: Res<Animations>,
132    mut current_animation: Local<usize>,
133) {
134    for (mut player, mut transitions) in &mut animation_players {
135        let Some((&playing_animation_index, _)) = player.playing_animations().next() else {
136            continue;
137        };
138
139        if keyboard_input.just_pressed(KeyCode::Space) {
140            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
141            if playing_animation.is_paused() {
142                playing_animation.resume();
143            } else {
144                playing_animation.pause();
145            }
146        }
147
148        if keyboard_input.just_pressed(KeyCode::ArrowUp) {
149            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
150            let speed = playing_animation.speed();
151            playing_animation.set_speed(speed * 1.2);
152        }
153
154        if keyboard_input.just_pressed(KeyCode::ArrowDown) {
155            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
156            let speed = playing_animation.speed();
157            playing_animation.set_speed(speed * 0.8);
158        }
159
160        if keyboard_input.just_pressed(KeyCode::ArrowLeft) {
161            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
162            let elapsed = playing_animation.seek_time();
163            playing_animation.seek_to(elapsed - 0.1);
164        }
165
166        if keyboard_input.just_pressed(KeyCode::ArrowRight) {
167            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
168            let elapsed = playing_animation.seek_time();
169            playing_animation.seek_to(elapsed + 0.1);
170        }
171
172        if keyboard_input.just_pressed(KeyCode::Enter) {
173            *current_animation = (*current_animation + 1) % animations.animations.len();
174
175            transitions
176                .play(
177                    &mut player,
178                    animations.animations[*current_animation],
179                    Duration::from_millis(250),
180                )
181                .repeat();
182        }
183
184        if keyboard_input.just_pressed(KeyCode::Digit1) {
185            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
186            playing_animation
187                .set_repeat(RepeatAnimation::Count(1))
188                .replay();
189        }
190
191        if keyboard_input.just_pressed(KeyCode::Digit2) {
192            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
193            playing_animation
194                .set_repeat(RepeatAnimation::Count(2))
195                .replay();
196        }
197
198        if keyboard_input.just_pressed(KeyCode::Digit3) {
199            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
200            playing_animation
201                .set_repeat(RepeatAnimation::Count(3))
202                .replay();
203        }
204
205        if keyboard_input.just_pressed(KeyCode::KeyL) {
206            let playing_animation = player.animation_mut(playing_animation_index).unwrap();
207            playing_animation.set_repeat(RepeatAnimation::Forever);
208        }
209    }
210}
examples/stress_tests/many_foxes.rs (lines 321-325)
271fn keyboard_animation_control(
272    keyboard_input: Res<ButtonInput<KeyCode>>,
273    mut animation_player: Query<(&mut AnimationPlayer, &mut AnimationTransitions)>,
274    animations: Res<Animations>,
275    mut current_animation: Local<usize>,
276    mut foxes: ResMut<Foxes>,
277) {
278    if keyboard_input.just_pressed(KeyCode::Space) {
279        foxes.moving = !foxes.moving;
280    }
281
282    if keyboard_input.just_pressed(KeyCode::ArrowUp) {
283        foxes.speed *= 1.25;
284    }
285
286    if keyboard_input.just_pressed(KeyCode::ArrowDown) {
287        foxes.speed *= 0.8;
288    }
289
290    if keyboard_input.just_pressed(KeyCode::Enter) {
291        *current_animation = (*current_animation + 1) % animations.node_indices.len();
292    }
293
294    for (mut player, mut transitions) in &mut animation_player {
295        if keyboard_input.just_pressed(KeyCode::Space) {
296            if player.all_paused() {
297                player.resume_all();
298            } else {
299                player.pause_all();
300            }
301        }
302
303        if keyboard_input.just_pressed(KeyCode::ArrowUp) {
304            player.adjust_speeds(1.25);
305        }
306
307        if keyboard_input.just_pressed(KeyCode::ArrowDown) {
308            player.adjust_speeds(0.8);
309        }
310
311        if keyboard_input.just_pressed(KeyCode::ArrowLeft) {
312            player.seek_all_by(-0.1);
313        }
314
315        if keyboard_input.just_pressed(KeyCode::ArrowRight) {
316            player.seek_all_by(0.1);
317        }
318
319        if keyboard_input.just_pressed(KeyCode::Enter) {
320            transitions
321                .play(
322                    &mut player,
323                    animations.node_indices[*current_animation],
324                    Duration::from_millis(250),
325                )
326                .repeat();
327        }
328    }
329}
examples/animation/animated_mesh_events.rs (line 181)
137fn setup_scene_once_loaded(
138    mut commands: Commands,
139    animations: Res<Animations>,
140    feet: Res<FoxFeetTargets>,
141    graphs: Res<Assets<AnimationGraph>>,
142    mut clips: ResMut<Assets<AnimationClip>>,
143    mut players: Query<(Entity, &mut AnimationPlayer), Added<AnimationPlayer>>,
144) {
145    fn get_clip<'a>(
146        node: AnimationNodeIndex,
147        graph: &AnimationGraph,
148        clips: &'a mut Assets<AnimationClip>,
149    ) -> &'a mut AnimationClip {
150        let node = graph.get(node).unwrap();
151        let clip = match &node.node_type {
152            AnimationNodeType::Clip(handle) => clips.get_mut(handle),
153            _ => unreachable!(),
154        };
155        clip.unwrap()
156    }
157
158    for (entity, mut player) in &mut players {
159        // Send `OnStep` events once the fox feet hits the ground in the running animation.
160
161        let graph = graphs.get(&animations.graph_handle).unwrap();
162        let running_animation = get_clip(animations.index, graph, &mut clips);
163
164        // You can determine the time an event should trigger if you know witch frame it occurs and
165        // the frame rate of the animation. Let's say we want to trigger an event at frame 15,
166        // and the animation has a frame rate of 24 fps, then time = 15 / 24 = 0.625.
167        running_animation.add_event_to_target(feet.front_left, 0.625, OnStep);
168        running_animation.add_event_to_target(feet.front_right, 0.5, OnStep);
169        running_animation.add_event_to_target(feet.back_left, 0.0, OnStep);
170        running_animation.add_event_to_target(feet.back_right, 0.125, OnStep);
171
172        // Start the animation
173
174        let mut transitions = AnimationTransitions::new();
175
176        // Make sure to start the animation via the `AnimationTransitions`
177        // component. The `AnimationTransitions` component wants to manage all
178        // the animations and will get confused if the animations are started
179        // directly via the `AnimationPlayer`.
180        transitions
181            .play(&mut player, animations.index, Duration::ZERO)
182            .repeat();
183
184        commands
185            .entity(entity)
186            .insert(AnimationGraphHandle(animations.graph_handle.clone()))
187            .insert(transitions);
188    }
189}
Source

pub fn get_main_animation(&self) -> Option<NodeIndex>

Obtain the currently playing main animation.

Trait Implementations§

Source§

impl Clone for AnimationTransitions

Source§

fn clone(&self) -> AnimationTransitions

Returns a copy of the value. Read more
Source§

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

Performs copy-assignment from source. Read more
Source§

impl Component for AnimationTransitions
where AnimationTransitions: Send + Sync + 'static,

Source§

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

A constant indicating the storage type used for this component.
Source§

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>]. Read more
Source§

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.
Source§

fn clone_behavior() -> ComponentCloneBehavior

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

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)
Called when registering this component, allowing mutable access to its ComponentHooks.
Source§

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

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

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

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

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

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

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

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

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

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

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] Read more
Source§

impl Default for AnimationTransitions

Source§

fn default() -> AnimationTransitions

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

impl FromArg for &'static AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

type This<'from_arg> = &'from_arg AnimationTransitions

The type to convert into. Read more
Source§

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static AnimationTransitions as FromArg>::This<'_>, ArgError>

Creates an item from an argument. Read more
Source§

impl FromArg for &'static mut AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

type This<'from_arg> = &'from_arg mut AnimationTransitions

The type to convert into. Read more
Source§

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static mut AnimationTransitions as FromArg>::This<'_>, ArgError>

Creates an item from an argument. Read more
Source§

impl FromArg for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

type This<'from_arg> = AnimationTransitions

The type to convert into. Read more
Source§

fn from_arg( arg: Arg<'_>, ) -> Result<<AnimationTransitions as FromArg>::This<'_>, ArgError>

Creates an item from an argument. Read more
Source§

impl FromReflect for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<AnimationTransitions>

Constructs a concrete instance of Self from a reflected value.
Source§

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. Read more
Source§

impl GetOwnership for &AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn ownership() -> Ownership

Returns the ownership of Self.
Source§

impl GetOwnership for &mut AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn ownership() -> Ownership

Returns the ownership of Self.
Source§

impl GetOwnership for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn ownership() -> Ownership

Returns the ownership of Self.
Source§

impl GetTypeRegistration for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.
Source§

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type. Read more
Source§

impl IntoReturn for &AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn into_return<'into_return>(self) -> Return<'into_return>
where &AnimationTransitions: 'into_return,

Converts Self into a Return value.
Source§

impl IntoReturn for &mut AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn into_return<'into_return>(self) -> Return<'into_return>
where &mut AnimationTransitions: 'into_return,

Converts Self into a Return value.
Source§

impl IntoReturn for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn into_return<'into_return>(self) -> Return<'into_return>
where AnimationTransitions: 'into_return,

Converts Self into a Return value.
Source§

impl PartialReflect for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

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

Returns the TypeInfo of the type represented by this value. Read more
Source§

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

Tries to apply a reflected value to this value. Read more
Source§

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type. Read more
Source§

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

Returns an immutable enumeration of “kinds” of type. Read more
Source§

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

Returns a mutable enumeration of “kinds” of type. Read more
Source§

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

Returns an owned enumeration of “kinds” of type. Read more
Source§

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

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

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

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

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

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

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

Casts this type to a boxed, reflected value. Read more
Source§

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value. Read more
Source§

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value. Read more
Source§

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

Returns a “partial equality” comparison result. Read more
Source§

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

Attempts to clone Self using reflection. Read more
Source§

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

Applies a reflected value to this value. Read more
Source§

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

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.
Clones Self into its dynamic representation. Read more
Source§

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

Converts this reflected value into its dynamic representation based on its kind. Read more
Source§

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

Returns a hash of the value (which includes the type). Read more
Source§

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

Debug formatter for the value. Read more
Source§

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type. Read more
Source§

impl Reflect for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

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

Returns the value as a Box<dyn Any>. Read more
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any. Read more
Source§

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

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

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.
Source§

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

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

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

Performs a type-checked assignment of a reflected value to this value. Read more
Source§

impl Struct for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

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

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

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

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

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

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

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

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

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

Returns the name of the field with index index.
Source§

fn field_len(&self) -> usize

Returns the number of fields in the struct.
Source§

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

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

fn to_dynamic_struct(&self) -> DynamicStruct

Source§

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead
Clones the struct into a DynamicStruct.
Source§

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

Will return None if TypeInfo is not available.
Source§

impl TypePath for AnimationTransitions

Source§

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type. Read more
Source§

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type. Read more
Source§

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

Returns the name of the type, or None if it is anonymous. Read more
Source§

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

Returns the name of the crate the type is in, or None if it is anonymous. Read more
Source§

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

Returns the path to the module the type is in, or None if it is anonymous. Read more
Source§

impl Typed for AnimationTransitions
where AnimationTransitions: Any + Send + Sync, Option<NodeIndex>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<AnimationTransition>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

Source§

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

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, U> AsBindGroupShaderType<U> for T
where U: ShaderType, &'a T: for<'a> Into<U>,

Source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
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<C> Bundle for C
where C: Component,

Source§

fn component_ids( components: &mut ComponentsRegistrator<'_>, ids: &mut impl FnMut(ComponentId), )

Source§

fn register_required_components( components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, )

Registers components that are required by the components in this Bundle.
Source§

fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>), )

Gets this Bundle’s component ids. This will be None if the component has not been registered.
Source§

impl<C> BundleFromComponents for C
where C: Component,

Source§

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

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

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast for T
where T: Any,

Source§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<C> DynamicBundle for C
where C: Component,

Source§

type Effect = ()

An operation on the entity that happens after inserting this bundle.
Source§

fn get_components( self, func: &mut impl FnMut(StorageType, OwningPtr<'_>), ) -> <C as DynamicBundle>::Effect

Source§

impl<T> DynamicTypePath for T
where T: TypePath,

Source§

impl<T> DynamicTyped for T
where T: Typed,

Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using default().

Source§

impl<S> GetField for S
where S: Struct,

Source§

fn get_field<T>(&self, name: &str) -> Option<&T>
where T: Reflect,

Returns a reference to the value of the field named name, downcast to T.
Source§

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>
where T: Reflect,

Returns a mutable reference to the value of the field named name, downcast to T.
Source§

impl<T> GetPath for T
where T: Reflect + ?Sized,

Source§

fn reflect_path<'p>( &self, path: impl ReflectPath<'p>, ) -> Result<&(dyn PartialReflect + 'static), ReflectPathError<'p>>

Returns a reference to the value specified by path. Read more
Source§

fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut (dyn PartialReflect + 'static), ReflectPathError<'p>>

Returns a mutable reference to the value specified by path. Read more
Source§

fn path<'p, T>( &self, path: impl ReflectPath<'p>, ) -> Result<&T, ReflectPathError<'p>>
where T: Reflect,

Returns a statically typed reference to the value specified by path. Read more
Source§

fn path_mut<'p, T>( &mut self, path: impl ReflectPath<'p>, ) -> Result<&mut T, ReflectPathError<'p>>
where T: Reflect,

Returns a statically typed mutable reference to the value specified by path. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> Reflectable for T

Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,