Struct gdnative::api::AnimationRootNode

pub struct AnimationRootNode { /* fields omitted */ }

core class AnimationRootNode inherits AnimationNode (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

AnimationRootNode inherits methods from:

• AnimationNode
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl AnimationRootNode

pub fn new() -> Ref<AnimationRootNode, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

Methods from Deref<Target = AnimationNode>

pub const FILTER_BLEND: i64

pub const FILTER_IGNORE: i64

pub const FILTER_PASS: i64

pub const FILTER_STOP: i64

pub fn add_input(&self, name: impl Into<GodotString>)

pub fn blend_animation(
    &self,
    animation: impl Into<GodotString>,
    time: f64,
    delta: f64,
    seeked: bool,
    blend: f64
)

pub fn blend_input(
    &self,
    input_index: i64,
    time: f64,
    seek: bool,
    blend: f64,
    filter: i64,
    optimize: bool
) -> f64

pub fn blend_node(
    &self,
    name: impl Into<GodotString>,
    node: impl AsArg<AnimationNode>,
    time: f64,
    seek: bool,
    blend: f64,
    filter: i64,
    optimize: bool
) -> f64

pub fn get_input_count(&self) -> i64

pub fn get_input_name(&self, input: i64) -> GodotString

pub fn get_parameter(&self, name: impl Into<GodotString>) -> Variant

pub fn is_filter_enabled(&self) -> bool

pub fn is_path_filtered(&self, path: impl Into<NodePath>) -> bool

pub fn remove_input(&self, index: i64)

pub fn set_filter_enabled(&self, enable: bool)

pub fn set_filter_path(&self, path: impl Into<NodePath>, enable: bool)

pub fn set_parameter(
    &self,
    name: impl Into<GodotString>,
    value: impl OwnedToVariant
)

Trait Implementations

impl Debug for AnimationRootNode

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

Formats the value using the given formatter.

impl Deref for AnimationRootNode

type Target = AnimationNode

The resulting type after dereferencing.

fn deref(&self) -> &AnimationNode

Dereferences the value.

impl DerefMut for AnimationRootNode

fn deref_mut(&mut self) -> &mut AnimationNode

Mutably dereferences the value.

impl GodotObject for AnimationRootNode

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for AnimationRootNode

fn construct() -> Ref<AnimationRootNode, Unique>

impl SubClass<AnimationNode> for AnimationRootNode

impl SubClass<AnimationRootNode> for AnimationNodeBlendSpace1D

impl SubClass<AnimationRootNode> for AnimationNodeBlendSpace2D

impl SubClass<AnimationRootNode> for AnimationNodeAnimation

impl SubClass<AnimationRootNode> for AnimationNodeStateMachine

impl SubClass<AnimationRootNode> for AnimationNodeBlendTree

impl SubClass<Object> for AnimationRootNode

impl SubClass<Reference> for AnimationRootNode

impl SubClass<Resource> for AnimationRootNode