AnimationClip

Struct AnimationClip 

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

A list of VariableCurves and the AnimationTargetIds to which they apply.

Because animation clips refer to targets by UUID, they can target any AnimationTarget with that ID.

Implementations§

Source§

impl AnimationClip

Source

pub fn curves( &self, ) -> &HashMap<AnimationTargetId, Vec<VariableCurve>, NoOpHash>

VariableCurves for each animation target. Indexed by the AnimationTargetId.

Source

pub fn curves_mut( &mut self, ) -> &mut HashMap<AnimationTargetId, Vec<VariableCurve>, NoOpHash>

Get mutable references of VariableCurves for each animation target. Indexed by the AnimationTargetId.

Source

pub fn curves_for_target( &self, target_id: AnimationTargetId, ) -> Option<&Vec<VariableCurve>>

Gets the curves for a single animation target.

Returns None if this clip doesn’t animate the target.

Source

pub fn curves_for_target_mut( &mut self, target_id: AnimationTargetId, ) -> Option<&mut Vec<VariableCurve>>

Gets mutable references of the curves for a single animation target.

Returns None if this clip doesn’t animate the target.

Source

pub fn duration(&self) -> f32

Duration of the clip, represented in seconds.

Source

pub fn set_duration(&mut self, duration_sec: f32)

Set the duration of the clip in seconds.

Examples found in repository?
examples/animation/animation_events.rs (line 71)
37fn setup(
38    mut commands: Commands,
39    mut animations: ResMut<Assets<AnimationClip>>,
40    mut graphs: ResMut<Assets<AnimationGraph>>,
41) {
42    // Camera
43    commands.spawn((
44        Camera2d,
45        Camera {
46            clear_color: ClearColorConfig::Custom(BLACK.into()),
47            ..Default::default()
48        },
49        Bloom {
50            intensity: 0.4,
51            ..Bloom::NATURAL
52        },
53    ));
54
55    // The text that will be changed by animation events.
56    commands.spawn((
57        MessageText,
58        Text2d::default(),
59        TextFont {
60            font_size: 119.0,
61            ..default()
62        },
63        TextColor(Color::NONE),
64    ));
65
66    // Create a new animation clip.
67    let mut animation = AnimationClip::default();
68
69    // This is only necessary if you want the duration of the
70    // animation to be longer than the last event in the clip.
71    animation.set_duration(2.0);
72
73    // Add events at the specified time.
74    animation.add_event(
75        0.0,
76        SetMessage {
77            value: "HELLO".into(),
78            color: ALICE_BLUE.into(),
79        },
80    );
81    animation.add_event(
82        1.0,
83        SetMessage {
84            value: "BYE".into(),
85            color: CRIMSON.into(),
86        },
87    );
88
89    // Create the animation graph.
90    let (graph, animation_index) = AnimationGraph::from_clip(animations.add(animation));
91    let mut player = AnimationPlayer::default();
92    player.play(animation_index).repeat();
93
94    commands.spawn((AnimationGraphHandle(graphs.add(graph)), player));
95}
Source

pub fn add_curve_to_target( &mut self, target_id: AnimationTargetId, curve: impl AnimationCurve, )

Adds an AnimationCurve to an AnimationTarget named by an AnimationTargetId.

If the curve extends beyond the current duration of this clip, this method lengthens this clip to include the entire time span that the curve covers.

More specifically:

  • This clip will be sampled on the interval [0, duration].
  • Each curve in the clip is sampled by first clamping the sample time to its domain.
  • Curves that extend forever never contribute to the duration.

For example, a curve with domain [2, 5] will extend the clip to cover [0, 5] when added and will produce the same output on the entire interval [0, 2] because these time values all get clamped to 2.

By contrast, a curve with domain [-10, ∞] will never extend the clip duration when added and will be sampled only on [0, duration], ignoring all negative time values.

Examples found in repository?
examples/animation/animated_ui.rs (lines 48-61)
36    fn create(
37        animation_graphs: &mut Assets<AnimationGraph>,
38        animation_clips: &mut Assets<AnimationClip>,
39    ) -> AnimationInfo {
40        // Create an ID that identifies the text node we're going to animate.
41        let animation_target_name = Name::new("Text");
42        let animation_target_id = AnimationTargetId::from_name(&animation_target_name);
43
44        // Allocate an animation clip.
45        let mut animation_clip = AnimationClip::default();
46
47        // Create a curve that animates font size.
48        animation_clip.add_curve_to_target(
49            animation_target_id,
50            AnimatableCurve::new(
51                animated_field!(TextFont::font_size),
52                AnimatableKeyframeCurve::new(
53                    [0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0]
54                        .into_iter()
55                        .zip([24.0, 80.0, 24.0, 80.0, 24.0, 80.0, 24.0]),
56                )
57                .expect(
58                    "should be able to build translation curve because we pass in valid samples",
59                ),
60            ),
61        );
62
63        // Create a curve that animates font color. Note that this should have
64        // the same time duration as the previous curve.
65        //
66        // This time we use a "custom property", which in this case animates TextColor under the assumption
67        // that it is in the "srgba" format.
68        animation_clip.add_curve_to_target(
69            animation_target_id,
70            AnimatableCurve::new(
71                TextColorProperty,
72                AnimatableKeyframeCurve::new([0.0, 1.0, 2.0, 3.0].into_iter().zip([
73                    Srgba::RED,
74                    Srgba::GREEN,
75                    Srgba::BLUE,
76                    Srgba::RED,
77                ]))
78                .expect(
79                    "should be able to build translation curve because we pass in valid samples",
80                ),
81            ),
82        );
83
84        // Save our animation clip as an asset.
85        let animation_clip_handle = animation_clips.add(animation_clip);
86
87        // Create an animation graph with that clip.
88        let (animation_graph, animation_node_index) =
89            AnimationGraph::from_clip(animation_clip_handle);
90        let animation_graph_handle = animation_graphs.add(animation_graph);
91
92        AnimationInfo {
93            target_name: animation_target_name,
94            target_id: animation_target_id,
95            graph: animation_graph_handle,
96            node_index: animation_node_index,
97        }
98    }
More examples
Hide additional examples
examples/animation/eased_motion.rs (lines 130-133)
93    fn create(
94        animation_graphs: &mut Assets<AnimationGraph>,
95        animation_clips: &mut Assets<AnimationClip>,
96    ) -> AnimationInfo {
97        // Create an ID that identifies the text node we're going to animate.
98        let animation_target_name = Name::new("Cube");
99        let animation_target_id = AnimationTargetId::from_name(&animation_target_name);
100
101        // Allocate an animation clip.
102        let mut animation_clip = AnimationClip::default();
103
104        // Each leg of the translation motion should take 3 seconds.
105        let animation_domain = interval(0.0, 3.0).unwrap();
106
107        // The easing curve is parametrized over [0, 1], so we reparametrize it and
108        // then ping-pong, which makes it spend another 3 seconds on the return journey.
109        let translation_curve = EasingCurve::new(
110            vec3(-6., 2., 0.),
111            vec3(6., 2., 0.),
112            EaseFunction::CubicInOut,
113        )
114        .reparametrize_linear(animation_domain)
115        .expect("this curve has bounded domain, so this should never fail")
116        .ping_pong()
117        .expect("this curve has bounded domain, so this should never fail");
118
119        // Something similar for rotation. The repetition here is an illusion caused
120        // by the symmetry of the cube; it rotates on the forward journey and never
121        // rotates back.
122        let rotation_curve = EasingCurve::new(
123            Quat::IDENTITY,
124            Quat::from_rotation_y(FRAC_PI_2),
125            EaseFunction::ElasticInOut,
126        )
127        .reparametrize_linear(interval(0.0, 4.0).unwrap())
128        .expect("this curve has bounded domain, so this should never fail");
129
130        animation_clip.add_curve_to_target(
131            animation_target_id,
132            AnimatableCurve::new(animated_field!(Transform::translation), translation_curve),
133        );
134        animation_clip.add_curve_to_target(
135            animation_target_id,
136            AnimatableCurve::new(animated_field!(Transform::rotation), rotation_curve),
137        );
138
139        // Save our animation clip as an asset.
140        let animation_clip_handle = animation_clips.add(animation_clip);
141
142        // Create an animation graph with that clip.
143        let (animation_graph, animation_node_index) =
144            AnimationGraph::from_clip(animation_clip_handle);
145        let animation_graph_handle = animation_graphs.add(animation_graph);
146
147        AnimationInfo {
148            target_name: animation_target_name,
149            target_id: animation_target_id,
150            graph: animation_graph_handle,
151            node_index: animation_node_index,
152        }
153    }
examples/animation/animated_transform.rs (lines 54-69)
22fn setup(
23    mut commands: Commands,
24    mut meshes: ResMut<Assets<Mesh>>,
25    mut materials: ResMut<Assets<StandardMaterial>>,
26    mut animations: ResMut<Assets<AnimationClip>>,
27    mut graphs: ResMut<Assets<AnimationGraph>>,
28) {
29    // Camera
30    commands.spawn((
31        Camera3d::default(),
32        Transform::from_xyz(-2.0, 2.5, 5.0).looking_at(Vec3::ZERO, Vec3::Y),
33    ));
34
35    // Light
36    commands.spawn((
37        PointLight {
38            intensity: 500_000.0,
39            ..default()
40        },
41        Transform::from_xyz(0.0, 2.5, 0.0),
42    ));
43
44    // Let's use the `Name` component to target entities. We can use anything we
45    // like, but names are convenient.
46    let planet = Name::new("planet");
47    let orbit_controller = Name::new("orbit_controller");
48    let satellite = Name::new("satellite");
49
50    // Creating the animation
51    let mut animation = AnimationClip::default();
52    // A curve can modify a single part of a transform: here, the translation.
53    let planet_animation_target_id = AnimationTargetId::from_name(&planet);
54    animation.add_curve_to_target(
55        planet_animation_target_id,
56        AnimatableCurve::new(
57            animated_field!(Transform::translation),
58            UnevenSampleAutoCurve::new([0.0, 1.0, 2.0, 3.0, 4.0].into_iter().zip([
59                Vec3::new(1.0, 0.0, 1.0),
60                Vec3::new(-1.0, 0.0, 1.0),
61                Vec3::new(-1.0, 0.0, -1.0),
62                Vec3::new(1.0, 0.0, -1.0),
63                // in case seamless looping is wanted, the last keyframe should
64                // be the same as the first one
65                Vec3::new(1.0, 0.0, 1.0),
66            ]))
67            .expect("should be able to build translation curve because we pass in valid samples"),
68        ),
69    );
70    // Or it can modify the rotation of the transform.
71    // To find the entity to modify, the hierarchy will be traversed looking for
72    // an entity with the right name at each level.
73    let orbit_controller_animation_target_id =
74        AnimationTargetId::from_names([planet.clone(), orbit_controller.clone()].iter());
75    animation.add_curve_to_target(
76        orbit_controller_animation_target_id,
77        AnimatableCurve::new(
78            animated_field!(Transform::rotation),
79            UnevenSampleAutoCurve::new([0.0, 1.0, 2.0, 3.0, 4.0].into_iter().zip([
80                Quat::IDENTITY,
81                Quat::from_axis_angle(Vec3::Y, PI / 2.),
82                Quat::from_axis_angle(Vec3::Y, PI / 2. * 2.),
83                Quat::from_axis_angle(Vec3::Y, PI / 2. * 3.),
84                Quat::IDENTITY,
85            ]))
86            .expect("Failed to build rotation curve"),
87        ),
88    );
89    // If a curve in an animation is shorter than the other, it will not repeat
90    // until all other curves are finished. In that case, another animation should
91    // be created for each part that would have a different duration / period.
92    let satellite_animation_target_id = AnimationTargetId::from_names(
93        [planet.clone(), orbit_controller.clone(), satellite.clone()].iter(),
94    );
95    animation.add_curve_to_target(
96        satellite_animation_target_id,
97        AnimatableCurve::new(
98            animated_field!(Transform::scale),
99            UnevenSampleAutoCurve::new(
100                [0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0]
101                    .into_iter()
102                    .zip([
103                        Vec3::splat(0.8),
104                        Vec3::splat(1.2),
105                        Vec3::splat(0.8),
106                        Vec3::splat(1.2),
107                        Vec3::splat(0.8),
108                        Vec3::splat(1.2),
109                        Vec3::splat(0.8),
110                        Vec3::splat(1.2),
111                        Vec3::splat(0.8),
112                    ]),
113            )
114            .expect("Failed to build scale curve"),
115        ),
116    );
117    // There can be more than one curve targeting the same entity path.
118    animation.add_curve_to_target(
119        AnimationTargetId::from_names(
120            [planet.clone(), orbit_controller.clone(), satellite.clone()].iter(),
121        ),
122        AnimatableCurve::new(
123            animated_field!(Transform::rotation),
124            UnevenSampleAutoCurve::new([0.0, 1.0, 2.0, 3.0, 4.0].into_iter().zip([
125                Quat::IDENTITY,
126                Quat::from_axis_angle(Vec3::Y, PI / 2.),
127                Quat::from_axis_angle(Vec3::Y, PI / 2. * 2.),
128                Quat::from_axis_angle(Vec3::Y, PI / 2. * 3.),
129                Quat::IDENTITY,
130            ]))
131            .expect("should be able to build translation curve because we pass in valid samples"),
132        ),
133    );
134
135    // Create the animation graph
136    let (graph, animation_index) = AnimationGraph::from_clip(animations.add(animation));
137
138    // Create the animation player, and set it to repeat
139    let mut player = AnimationPlayer::default();
140    player.play(animation_index).repeat();
141
142    // Create the scene that will be animated
143    // First entity is the planet
144    let planet_entity = commands
145        .spawn((
146            Mesh3d(meshes.add(Sphere::default())),
147            MeshMaterial3d(materials.add(Color::srgb(0.8, 0.7, 0.6))),
148            // Add the animation graph and player
149            planet,
150            AnimationGraphHandle(graphs.add(graph)),
151            player,
152        ))
153        .id();
154    commands.entity(planet_entity).insert((
155        AnimationTarget {
156            id: planet_animation_target_id,
157            player: planet_entity,
158        },
159        children![(
160            Transform::default(),
161            Visibility::default(),
162            orbit_controller,
163            AnimationTarget {
164                id: orbit_controller_animation_target_id,
165                player: planet_entity,
166            },
167            children![(
168                Mesh3d(meshes.add(Cuboid::new(0.5, 0.5, 0.5))),
169                MeshMaterial3d(materials.add(Color::srgb(0.3, 0.9, 0.3))),
170                Transform::from_xyz(1.5, 0.0, 0.0),
171                AnimationTarget {
172                    id: satellite_animation_target_id,
173                    player: planet_entity,
174                },
175                satellite,
176            )],
177        )],
178    ));
179}
Source

pub fn add_variable_curve_to_target( &mut self, target_id: AnimationTargetId, variable_curve: VariableCurve, )

Like add_curve_to_target, but adding a VariableCurve directly.

Under normal circumstances, that method is generally more convenient.

Source

pub fn add_event(&mut self, time: f32, event: impl AnimationEvent)

Add an EntityEvent with no AnimationTarget to this AnimationClip.

The event will be cloned and triggered on the AnimationPlayer entity once the time (in seconds) is reached in the animation.

See also add_event_to_target.

Examples found in repository?
examples/animation/animation_events.rs (lines 74-80)
37fn setup(
38    mut commands: Commands,
39    mut animations: ResMut<Assets<AnimationClip>>,
40    mut graphs: ResMut<Assets<AnimationGraph>>,
41) {
42    // Camera
43    commands.spawn((
44        Camera2d,
45        Camera {
46            clear_color: ClearColorConfig::Custom(BLACK.into()),
47            ..Default::default()
48        },
49        Bloom {
50            intensity: 0.4,
51            ..Bloom::NATURAL
52        },
53    ));
54
55    // The text that will be changed by animation events.
56    commands.spawn((
57        MessageText,
58        Text2d::default(),
59        TextFont {
60            font_size: 119.0,
61            ..default()
62        },
63        TextColor(Color::NONE),
64    ));
65
66    // Create a new animation clip.
67    let mut animation = AnimationClip::default();
68
69    // This is only necessary if you want the duration of the
70    // animation to be longer than the last event in the clip.
71    animation.set_duration(2.0);
72
73    // Add events at the specified time.
74    animation.add_event(
75        0.0,
76        SetMessage {
77            value: "HELLO".into(),
78            color: ALICE_BLUE.into(),
79        },
80    );
81    animation.add_event(
82        1.0,
83        SetMessage {
84            value: "BYE".into(),
85            color: CRIMSON.into(),
86        },
87    );
88
89    // Create the animation graph.
90    let (graph, animation_index) = AnimationGraph::from_clip(animations.add(animation));
91    let mut player = AnimationPlayer::default();
92    player.play(animation_index).repeat();
93
94    commands.spawn((AnimationGraphHandle(graphs.add(graph)), player));
95}
Source

pub fn add_event_to_target( &mut self, target_id: AnimationTargetId, time: f32, event: impl AnimationEvent, )

Add an EntityEvent to an AnimationTarget named by an AnimationTargetId.

The event will be cloned and triggered on the entity matching the target once the time (in seconds) is reached in the animation.

Use add_event instead if you don’t have a specific target.

Examples found in repository?
examples/animation/animated_mesh_events.rs (line 172)
142fn setup_scene_once_loaded(
143    mut commands: Commands,
144    animations: Res<Animations>,
145    feet: Res<FoxFeetTargets>,
146    graphs: Res<Assets<AnimationGraph>>,
147    mut clips: ResMut<Assets<AnimationClip>>,
148    mut players: Query<(Entity, &mut AnimationPlayer), Added<AnimationPlayer>>,
149) {
150    fn get_clip<'a>(
151        node: AnimationNodeIndex,
152        graph: &AnimationGraph,
153        clips: &'a mut Assets<AnimationClip>,
154    ) -> &'a mut AnimationClip {
155        let node = graph.get(node).unwrap();
156        let clip = match &node.node_type {
157            AnimationNodeType::Clip(handle) => clips.get_mut(handle),
158            _ => unreachable!(),
159        };
160        clip.unwrap()
161    }
162
163    for (entity, mut player) in &mut players {
164        // Send `OnStep` events once the fox feet hits the ground in the running animation.
165
166        let graph = graphs.get(&animations.graph_handle).unwrap();
167        let running_animation = get_clip(animations.index, graph, &mut clips);
168
169        // You can determine the time an event should trigger if you know witch frame it occurs and
170        // the frame rate of the animation. Let's say we want to trigger an event at frame 15,
171        // and the animation has a frame rate of 24 fps, then time = 15 / 24 = 0.625.
172        running_animation.add_event_to_target(feet.front_left, 0.625, Step);
173        running_animation.add_event_to_target(feet.front_right, 0.5, Step);
174        running_animation.add_event_to_target(feet.back_left, 0.0, Step);
175        running_animation.add_event_to_target(feet.back_right, 0.125, Step);
176
177        // Start the animation
178
179        let mut transitions = AnimationTransitions::new();
180
181        // Make sure to start the animation via the `AnimationTransitions`
182        // component. The `AnimationTransitions` component wants to manage all
183        // the animations and will get confused if the animations are started
184        // directly via the `AnimationPlayer`.
185        transitions
186            .play(&mut player, animations.index, Duration::ZERO)
187            .repeat();
188
189        commands
190            .entity(entity)
191            .insert(AnimationGraphHandle(animations.graph_handle.clone()))
192            .insert(transitions);
193    }
194}
Source

pub fn add_event_fn( &mut self, time: f32, func: impl Fn(&mut Commands<'_, '_>, Entity, f32, f32) + Send + Sync + 'static, )

Add an event function with no AnimationTarget to this AnimationClip.

The func will trigger on the AnimationPlayer entity once the time (in seconds) is reached in the animation.

For a simpler EntityEvent-based alternative, see AnimationClip::add_event. See also add_event_to_target.

clip.add_event_fn(1.0, |commands, entity, time, weight| {
  println!("Animation event triggered {entity:#?} at time {time} with weight {weight}");
})
Source

pub fn add_event_fn_to_target( &mut self, target_id: AnimationTargetId, time: f32, func: impl Fn(&mut Commands<'_, '_>, Entity, f32, f32) + Send + Sync + 'static, )

Add an event function to an AnimationTarget named by an AnimationTargetId.

The func will trigger on the entity matching the target once the time (in seconds) is reached in the animation.

For a simpler EntityEvent-based alternative, see AnimationClip::add_event_to_target. Use add_event instead if you don’t have a specific target.

clip.add_event_fn_to_target(AnimationTargetId::from_iter(["Arm", "Hand"]), 1.0, |commands, entity, time, weight| {
  println!("Animation event triggered {entity:#?} at time {time} with weight {weight}");
})

Trait Implementations§

Source§

impl Clone for AnimationClip

Source§

fn clone(&self) -> AnimationClip

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnimationClip

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AnimationClip

Source§

fn default() -> AnimationClip

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

impl FromArg for AnimationClip

Source§

type This<'from_arg> = AnimationClip

The type to convert into. Read more
Source§

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

Creates an item from an argument. Read more
Source§

impl FromReflect for AnimationClip

Source§

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

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 AnimationClip

Source§

fn ownership() -> Ownership

Returns the ownership of Self.
Source§

impl GetTypeRegistration for AnimationClip

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 AnimationClip

Source§

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

Converts Self into a Return value.
Source§

impl PartialReflect for AnimationClip

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<AnimationClip>) -> ReflectOwned

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

fn try_into_reflect( self: Box<AnimationClip>, ) -> 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<AnimationClip>) -> 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 to_dynamic(&self) -> Box<dyn PartialReflect>

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

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. 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 AnimationClip

Source§

fn into_any(self: Box<AnimationClip>) -> 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<AnimationClip>) -> 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 AnimationClip

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

Creates a new DynamicStruct from this struct.
Source§

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

Will return None if TypeInfo is not available.
Source§

impl TypePath for AnimationClip

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 AnimationClip

Source§

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.
Source§

impl VisitAssetDependencies for AnimationClip

Source§

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

Source§

impl Asset for AnimationClip

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<A> AssetContainer for A
where A: Asset,

Source§

fn insert(self: Box<A>, id: UntypedAssetId, world: &mut World)

Source§

fn asset_type_name(&self) -> &'static str

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<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 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 + Sync + Send>

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<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, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
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<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

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

Source§

fn into_sample(self) -> T

Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
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§

fn clone_type_data(&self) -> Box<dyn TypeData>

Creates a type-erased clone of this value.
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,