Struct gdnative::api::AnimationNodeBlendTree

pub struct AnimationNodeBlendTree { /* fields omitted */ }

core class AnimationNodeBlendTree inherits AnimationRootNode (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

AnimationNodeBlendTree inherits methods from:

• AnimationRootNode
• 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 AnimationNodeBlendTree

Constants

pub const CONNECTION_ERROR_CONNECTION_EXISTS: i64

pub const CONNECTION_ERROR_NO_INPUT: i64

pub const CONNECTION_ERROR_NO_INPUT_INDEX: i64

pub const CONNECTION_ERROR_NO_OUTPUT: i64

pub const CONNECTION_ERROR_SAME_NODE: i64

pub const CONNECTION_OK: i64

impl AnimationNodeBlendTree

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

Creates a new instance of this object.

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

pub fn add_node(
    &self,
    name: impl Into<GodotString>,
    node: impl AsArg<AnimationNode>,
    position: Vector2D<f32, UnknownUnit>
)

Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later.

Default Arguments

• position - Vector2( 0, 0 )

pub fn connect_node(
    &self,
    input_node: impl Into<GodotString>,
    input_index: i64,
    output_node: impl Into<GodotString>
)

Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code].

pub fn disconnect_node(
    &self,
    input_node: impl Into<GodotString>,
    input_index: i64
)

Disconnects the node connected to the specified input.

pub fn graph_offset(&self) -> Vector2D<f32, UnknownUnit>

The global offset of all sub-nodes.

pub fn get_node(
    &self,
    name: impl Into<GodotString>
) -> Option<Ref<AnimationNode, Shared>>

Returns the sub-node with the specified [code]name[/code].

pub fn get_node_position(
    &self,
    name: impl Into<GodotString>
) -> Vector2D<f32, UnknownUnit>

Returns the position of the sub-node with the specified [code]name[/code].

pub fn has_node(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists.

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

Removes a sub-node.

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

Changes the name of a sub-node.

pub fn set_graph_offset(&self, offset: Vector2D<f32, UnknownUnit>)

The global offset of all sub-nodes.

pub fn set_node_position(
    &self,
    name: impl Into<GodotString>,
    position: Vector2D<f32, UnknownUnit>
)

Modifies the position of a sub-node.

Methods from Deref<Target = AnimationRootNode>

Trait Implementations

impl Debug for AnimationNodeBlendTree

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

Formats the value using the given formatter.

impl Deref for AnimationNodeBlendTree

type Target = AnimationRootNode

The resulting type after dereferencing.

fn deref(&self) -> &AnimationRootNode

Dereferences the value.

impl DerefMut for AnimationNodeBlendTree

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

Mutably dereferences the value.

impl GodotObject for AnimationNodeBlendTree

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 AnimationNodeBlendTree

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

impl SubClass<AnimationNode> for AnimationNodeBlendTree

impl SubClass<AnimationRootNode> for AnimationNodeBlendTree

impl SubClass<Object> for AnimationNodeBlendTree

impl SubClass<Reference> for AnimationNodeBlendTree

impl SubClass<Resource> for AnimationNodeBlendTree