Struct ThreadedAnimationGraph 

pub struct ThreadedAnimationGraph {
    pub threaded_graph: Vec<NodeIndex>,
    pub sorted_edge_ranges: Vec<Range<u32>>,
    pub sorted_edges: Vec<NodeIndex>,
    pub computed_masks: Vec<u64>,
}

An acceleration structure for an animation graph that allows Bevy to evaluate it quickly.

This is kept up to date as the associated AnimationGraph instance is added, modified, or removed.

Fields

threaded_graph: Vec<NodeIndex>

A cached postorder traversal of the graph.

The node indices here are stored in postorder. Siblings are stored in descending order. This is because the AnimationCurveEvaluator uses a stack for evaluation. Consider this graph:

            ┌─────┐
            │     │
            │  1  │
            │     │
            └──┬──┘
               │
       ┌───────┼───────┐
       │       │       │
       ▼       ▼       ▼
    ┌─────┐ ┌─────┐ ┌─────┐
    │     │ │     │ │     │
    │  2  │ │  3  │ │  4  │
    │     │ │     │ │     │
    └──┬──┘ └─────┘ └─────┘
       │
   ┌───┴───┐
   │       │
   ▼       ▼
┌─────┐ ┌─────┐
│     │ │     │
│  5  │ │  6  │
│     │ │     │
└─────┘ └─────┘

The postorder traversal in this case will be (4, 3, 6, 5, 2, 1).

The fact that the children of each node are sorted in reverse ensures that, at each level, the order of blending proceeds in ascending order by node index, as we guarantee. To illustrate this, consider the way the graph above is evaluated. (Interpolation is represented with the ⊕ symbol.)

Step	Node	Operation	Stack (after operation)	Blend Register
1	4	Push	4
2	3	Push	4 3
3	6	Push	4 3 6
4	5	Push	4 3 6 5
5	2	Blend 5	4 3 6	5
6	2	Blend 6	4 3	5 ⊕ 6
7	2	Push Blend	4 3 2
8	1	Blend 2	4 3	2
9	1	Blend 3	4	2 ⊕ 3
10	1	Blend 4		2 ⊕ 3 ⊕ 4
11	1	Push Blend	1
12		Commit

sorted_edge_ranges: Vec<Range<u32>>

A mapping from each parent node index to the range within Self::sorted_edges.

This allows for quick lookup of the children of each node, sorted in ascending order of node index, without having to sort the result of the petgraph traversal functions every frame.

sorted_edges: Vec<NodeIndex>

A list of the children of each node, sorted in ascending order.

computed_masks: Vec<u64>

A mapping from node index to a bitfield specifying the mask groups that this node masks out (i.e. doesn’t animate).

A 1 in bit position N indicates that this node doesn’t animate any targets of mask group N.

Trait Implementations

impl Default for ThreadedAnimationGraph

fn default() -> ThreadedAnimationGraph

Returns the “default value” for a type.

impl FromArg for ThreadedAnimationGraph

type This<'from_arg> = ThreadedAnimationGraph

The type to convert into.

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

Creates an item from an argument.

impl FromReflect for ThreadedAnimationGraph

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

Constructs a concrete instance of Self from a reflected value.

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.

impl GetOwnership for ThreadedAnimationGraph

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for ThreadedAnimationGraph

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for ThreadedAnimationGraph

fn into_return<'into_return>(self) -> Return<'into_return>

where ThreadedAnimationGraph: 'into_return,

Converts Self into a Return value.

impl PartialReflect for ThreadedAnimationGraph

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

Returns the TypeInfo of the type represented by this value.

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

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

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

Returns an owned enumeration of “kinds” of type.

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

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

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

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

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

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

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

Casts this type to a boxed, reflected value.

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

Casts this type to a reflected value.

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

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

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

Attempts to clone Self using reflection.

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

Applies a reflected value to this value.

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

Converts this reflected value into its dynamic representation based on its kind.

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.

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

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

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ThreadedAnimationGraph

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

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

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

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

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

Casts this type to a fully-reflected value.

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

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

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

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

impl Struct for ThreadedAnimationGraph

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

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

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.

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.

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.

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

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

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

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

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

Will return None if TypeInfo is not available.

impl TypePath for ThreadedAnimationGraph

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

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

Returns the name of the type, or None if it is anonymous.

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

Returns the name of the crate the type is in, or None if it is anonymous.

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

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ThreadedAnimationGraph

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.