Struct AnimationGraph

pub struct AnimationGraph {
    pub nodes: HashMap<String, AnimationNode>,
    pub edges: HashMap<TargetPin, SourcePin>,
    pub edges_inverted: HashMap<SourcePin, TargetPin>,
    pub default_parameters: PinMap<DataValue>,
    pub input_times: PinMap<()>,
    pub output_parameters: PinMap<DataSpec>,
    pub output_time: Option<()>,
    pub extra: Extra,
}

Fields

nodes: HashMap<String, AnimationNode>

edges: HashMap<TargetPin, SourcePin>

Inverted, indexed by end pin.

edges_inverted: HashMap<SourcePin, TargetPin>

Inverted from the inverted state (inverted squared), indexed by start pin.

default_parameters: PinMap<DataValue>

input_times: PinMap<()>

output_parameters: PinMap<DataSpec>

output_time: Option<()>

extra: Extra

Implementations

impl AnimationGraph

pub fn new() -> Self

pub fn add_node(&mut self, node: AnimationNode)

Add a new node to the graph

pub fn remove_node(&mut self, node_id: impl Into<NodeId>)

Add a new node to the graph

pub fn add_edge(&mut self, source_pin: SourcePin, target_pin: TargetPin)

Add a new edge to the graph

pub fn remove_edge_by_target( &mut self, target_pin: &TargetPin, ) -> Option<SourcePin>

Remove an edge from the graph.

pub fn rename_node( &mut self, old_node_id: impl Into<NodeId>, new_node_id: impl Into<NodeId>, ) -> bool

Rename node if node exists and new name is available, otherwise return false. Will rename all references to the node in the graph.

pub fn set_default_parameter( &mut self, parameter_name: impl Into<String>, value: DataValue, )

Sets the value for a default parameter, registering it if it wasn’t yet done

pub fn get_default_parameter( &mut self, parameter_name: &str, ) -> Option<DataValue>

Get the default value of an input parameter, if it exists

pub fn add_input_time(&mut self, pin_id: impl Into<PinId>)

Register an input pose pin for the graph

pub fn add_output_parameter(&mut self, pin_id: impl Into<PinId>, spec: DataSpec)

Register an output parameter for the graph

pub fn add_output_time(&mut self)

Enables time “output” for this graph

pub fn add_input_parameter_edge( &mut self, parameter_name: impl Into<PinId>, target_node: impl Into<NodeId>, target_edge: impl Into<PinId>, )

pub fn add_output_parameter_edge( &mut self, source_node: impl Into<NodeId>, source_edge: impl Into<PinId>, output_name: impl Into<PinId>, )

pub fn add_input_pose_edge( &mut self, input_name: impl Into<PinId>, target_node: impl Into<NodeId>, target_edge: impl Into<PinId>, )

pub fn add_output_pose_edge(&mut self, source_node: impl Into<NodeId>)

pub fn add_node_parameter_edge( &mut self, source_node: impl Into<NodeId>, source_pin: impl Into<PinId>, target_node: impl Into<NodeId>, target_pin: impl Into<PinId>, )

Adds an edge between two nodes in the graph

pub fn add_node_pose_edge( &mut self, source_node: impl Into<NodeId>, target_node: impl Into<NodeId>, target_pin: impl Into<PinId>, )

Adds an edge between two node pose pins in the graph

pub fn validate(&self) -> Result<(), GraphValidationError>

pub fn can_add_edge( &self, edge: Edge, ctx: SpecContext<'_>, ) -> Result<(), Option<Edge>>

Check whether a new edge can be added to the graph. If not, return whether an edge can be removed to maybe make it possible. It is not guaranteed that the edge will be legal after a single edge removal, so this function should be called repeatedly until it returns Ok(()) or Err(None)

pub fn validate_edges(&self, ctx: SpecContext<'_>) -> Result<(), HashSet<Edge>>

Verify that graph edges are legal. If not, return a set of edges that when removed would make the graph legal.

Reasons for edges to make the graph illegal are:

• Two pose edges share the same source.
• An edge source and target pins have different types. This could be:
  • Pose pin connected to a parameter pin.
  • Pose type mismatch.
  • Parameter type mismatch.
• An edge source pin, target pin or both are missing. This could be because:
  • The source node, target node or both are missing.
  • The source node or target node do not have the named pin.
• Cycle.

pub fn contains_state_machine( &self, fsm: impl Into<AssetId<StateMachine>>, ) -> Option<NodeId>

Check whether a given state machine AssetId is present as a node in the graph. If true, returns name of node containing the state machine.

pub fn get_data( &self, target_pin: TargetPin, ctx: PassContext<'_>, ) -> Result<DataValue, GraphError>

pub fn get_duration( &self, target_pin: TargetPin, ctx: PassContext<'_>, ) -> Result<DurationData, GraphError>

pub fn get_time_update( &self, source_pin: SourcePin, ctx: PassContext<'_>, ) -> Result<TimeUpdate, GraphError>

pub fn query( &self, time_update: TimeUpdate, context_arena: &mut GraphContextArena, resources: &SystemResources<'_, '_>, root_entity: Entity, entity_map: &HashMap<BoneId, Entity>, deferred_gizmos: &mut DeferredGizmos, ) -> Result<HashMap<PinId, DataValue>, GraphError>

pub fn query_with_overlay( &self, time_update: TimeUpdate, context_arena: &mut GraphContextArena, resources: &SystemResources<'_, '_>, overlay: &InputOverlay, root_entity: Entity, entity_map: &HashMap<BoneId, Entity>, deferred_gizmos: &mut DeferredGizmos, ) -> Result<HashMap<PinId, DataValue>, GraphError>

Trait Implementations

impl Clone for AnimationGraph

fn clone(&self) -> AnimationGraph

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AnimationGraph

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

Formats the value using the given formatter.

impl Default for AnimationGraph

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for AnimationGraph

where AnimationGraph: Any + Send + Sync, PinMap<DataValue>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<DataSpec>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

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 GetTypeRegistration for AnimationGraph

where AnimationGraph: Any + Send + Sync, PinMap<DataValue>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<DataSpec>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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 PartialReflect for AnimationGraph

where AnimationGraph: Any + Send + Sync, PinMap<DataValue>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<DataSpec>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> 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>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> 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 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.

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

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

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 AnimationGraph

where AnimationGraph: Any + Send + Sync, PinMap<DataValue>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<DataSpec>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

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

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

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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 AnimationGraph

where AnimationGraph: Any + Send + Sync, PinMap<DataValue>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<DataSpec>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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>

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>

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>

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

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

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

Will return None if TypeInfo is not available.

impl TypePath for AnimationGraph

where AnimationGraph: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

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

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

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

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

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

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

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

impl Typed for AnimationGraph

where AnimationGraph: Any + Send + Sync, PinMap<DataValue>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, PinMap<DataSpec>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<()>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VisitAssetDependencies for AnimationGraph

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

impl Asset for AnimationGraph