Struct gdnative::api::Skeleton

pub struct Skeleton { /* fields omitted */ }

core class Skeleton inherits Spatial (unsafe).

Official documentation

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

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

Skeleton is a reference-only type. Persistent references can only exist in the unsafe Ref<Skeleton> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

Skeleton inherits methods from:

• Spatial
• Node
• 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 Skeleton

Constants

pub const NOTIFICATION_UPDATE_SKELETON: i64

impl Skeleton

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

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ptr::free, or preferably Ptr::queue_free if it is a Node.

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

pub fn bind_child_node_to_bone(&self, bone_idx: i64, node: impl AsArg<Node>)

pub fn clear_bones(&self)

pub fn clear_bones_global_pose_override(&self)

pub fn find_bone(&self, name: impl Into<GodotString>) -> i64

pub fn get_bone_count(&self) -> i64

pub fn get_bone_custom_pose(&self, bone_idx: i64) -> Transform

pub fn get_bone_global_pose(&self, bone_idx: i64) -> Transform

pub fn get_bone_name(&self, bone_idx: i64) -> GodotString

pub fn get_bone_parent(&self, bone_idx: i64) -> i64

pub fn get_bone_pose(&self, bone_idx: i64) -> Transform

pub fn get_bone_rest(&self, bone_idx: i64) -> Transform

pub fn get_bound_child_nodes_to_bone(
    &self,
    bone_idx: i64
) -> VariantArray<Shared>

pub fn is_bone_rest_disabled(&self, bone_idx: i64) -> bool

pub fn localize_rests(&self)

pub fn physical_bones_add_collision_exception(&self, exception: Rid)

pub fn physical_bones_remove_collision_exception(&self, exception: Rid)

pub fn physical_bones_start_simulation(&self, bones: VariantArray<Shared>)

pub fn physical_bones_stop_simulation(&self)

pub fn register_skin(
    &self,
    skin: impl AsArg<Skin>
) -> Option<Ref<SkinReference, Shared>>

pub fn set_bone_custom_pose(&self, bone_idx: i64, custom_pose: Transform)

pub fn set_bone_disable_rest(&self, bone_idx: i64, disable: bool)

pub fn set_bone_global_pose_override(
    &self,
    bone_idx: i64,
    pose: Transform,
    amount: f64,
    persistent: bool
)

pub fn set_bone_parent(&self, bone_idx: i64, parent_idx: i64)

pub fn set_bone_pose(&self, bone_idx: i64, pose: Transform)

pub fn set_bone_rest(&self, bone_idx: i64, rest: Transform)

pub fn unbind_child_node_from_bone(&self, bone_idx: i64, node: impl AsArg<Node>)

pub fn unparent_bone_and_rest(&self, bone_idx: i64)

Methods from Deref<Target = Spatial>

pub const NOTIFICATION_ENTER_WORLD: i64

pub const NOTIFICATION_EXIT_WORLD: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub fn force_update_transform(&self)

pub fn gizmo(&self) -> Option<Ref<SpatialGizmo, Shared>>

pub fn global_transform(&self) -> Transform

pub fn get_parent_spatial(&self) -> Option<Ref<Spatial, Shared>>

pub fn rotation(&self) -> Vector3D<f32, UnknownUnit>

pub fn rotation_degrees(&self) -> Vector3D<f32, UnknownUnit>

pub fn scale(&self) -> Vector3D<f32, UnknownUnit>

pub fn transform(&self) -> Transform

pub fn translation(&self) -> Vector3D<f32, UnknownUnit>

pub fn get_world(&self) -> Option<Ref<World, Shared>>

pub fn global_rotate(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

pub fn global_scale(&self, scale: Vector3D<f32, UnknownUnit>)

pub fn global_translate(&self, offset: Vector3D<f32, UnknownUnit>)

pub fn hide(&self)

pub fn is_local_transform_notification_enabled(&self) -> bool

pub fn is_scale_disabled(&self) -> bool

pub fn is_set_as_toplevel(&self) -> bool

pub fn is_transform_notification_enabled(&self) -> bool

pub fn is_visible(&self) -> bool

pub fn is_visible_in_tree(&self) -> bool

pub fn look_at(
    &self,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

pub fn look_at_from_position(
    &self,
    position: Vector3D<f32, UnknownUnit>,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

pub fn orthonormalize(&self)

pub fn rotate(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

pub fn rotate_object_local(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

pub fn rotate_x(&self, angle: f64)

pub fn rotate_y(&self, angle: f64)

pub fn rotate_z(&self, angle: f64)

pub fn scale_object_local(&self, scale: Vector3D<f32, UnknownUnit>)

pub fn set_as_toplevel(&self, enable: bool)

pub fn set_disable_scale(&self, disable: bool)

pub fn set_gizmo(&self, gizmo: impl AsArg<SpatialGizmo>)

pub fn set_global_transform(&self, global: Transform)

pub fn set_identity(&self)

pub fn set_ignore_transform_notification(&self, enabled: bool)

pub fn set_notify_local_transform(&self, enable: bool)

pub fn set_notify_transform(&self, enable: bool)

pub fn set_rotation(&self, euler: Vector3D<f32, UnknownUnit>)

pub fn set_rotation_degrees(&self, euler_degrees: Vector3D<f32, UnknownUnit>)

pub fn set_scale(&self, scale: Vector3D<f32, UnknownUnit>)

pub fn set_transform(&self, local: Transform)

pub fn set_translation(&self, translation: Vector3D<f32, UnknownUnit>)

pub fn set_visible(&self, visible: bool)

pub fn show(&self)

pub fn to_global(
    &self,
    local_point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub fn to_local(
    &self,
    global_point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub fn translate(&self, offset: Vector3D<f32, UnknownUnit>)

pub fn translate_object_local(&self, offset: Vector3D<f32, UnknownUnit>)

pub fn update_gizmo(&self)

Trait Implementations

impl Debug for Skeleton

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

Formats the value using the given formatter.

impl Deref for Skeleton

type Target = Spatial

The resulting type after dereferencing.

fn deref(&self) -> &Spatial

Dereferences the value.

impl DerefMut for Skeleton

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

Mutably dereferences the value.

impl GodotObject for Skeleton

type RefKind = ManuallyManaged

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 Skeleton

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

impl QueueFree for Skeleton

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<Node> for Skeleton

impl SubClass<Object> for Skeleton

impl SubClass<Spatial> for Skeleton