Struct State 

pub struct State<T: EntityId> {
    pub position: Vector2<f32>,
    pub name: String,
    pub on_enter_actions: Vec<StateActionWrapper<T>>,
    pub on_leave_actions: Vec<StateActionWrapper<T>>,
    pub root: Handle<PoseNode<T>>,
}

State is a final “container” for animation pose. It has backing pose node which provides a set of values. States can be connected with each other using transitions, states with transitions form a state graph.

Fields

position: Vector2<f32>

Position of state on the canvas. It is editor-specific data.

name: String

Name of the state.

on_enter_actions: Vec<StateActionWrapper<T>>

A set of actions that will be executed when entering the state.

on_leave_actions: Vec<StateActionWrapper<T>>

A set of actions that will be executed when leaving the state.

root: Handle<PoseNode<T>>

Root node of the state that provides the state with animation data.

Implementations

impl<T: EntityId> State<T>

pub const POSITION: &'static str = "position"

pub const NAME: &'static str = "name"

pub const ON_ENTER_ACTIONS: &'static str = "on_enter_actions"

pub const ON_LEAVE_ACTIONS: &'static str = "on_leave_actions"

pub const ROOT: &'static str = "root"

impl<T: EntityId> State<T>

pub fn new(name: &str, root: Handle<PoseNode<T>>) -> Self

Creates new instance of state with a given pose.

pub fn pose<'a>( &self, nodes: &'a Pool<PoseNode<T>>, ) -> Result<Ref<'a, AnimationPose<T>>, PoolError>

Returns a final pose of the state.

pub fn collect_animations( &self, nodes: &Pool<PoseNode<T>>, animations: &mut FxHashSet<Handle<Animation<T>>>, )

Collects all animation handles used by this state.

Trait Implementations

impl<T: Clone + EntityId> Clone for State<T>

fn clone(&self) -> State<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + EntityId> Debug for State<T>

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

Formats the value using the given formatter.

impl<T: Default + EntityId> Default for State<T>

fn default() -> State<T>

Returns the “default value” for a type.

impl<T: EntityId> NameProvider for State<T>

fn name(&self) -> &str

Returns a reference to the name of the entity.

impl<T: PartialEq + EntityId> PartialEq for State<T>

fn eq(&self, other: &State<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: EntityId> Reflect for State<T>

where Self: 'static,

fn source_path() -> &'static str

fn try_clone_box(&self) -> Option<Box<dyn Reflect>>

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

fn derived_types() -> &'static [TypeId]

fn query_derived_types(&self) -> &'static [TypeId]

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

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

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_ref(&self, func: &mut dyn FnMut(&[FieldRef<'_, '_>]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [FieldMut<'_, '_>]))

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

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

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn set_field( &mut self, field_name: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, SetFieldError>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>), )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>), )

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

fn as_handle( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHandle + 'static)>), )

fn as_handle_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHandle + 'static)>), )

impl<T: EntityId> Visit for State<T>

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl<T: EntityId> StructuralPartialEq for State<T>