Struct gdnative::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 an unsafe pointer, and all of its methods are unsafe.

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 Skeleton::free.

Class hierarchy

Skeleton inherits methods from:

• Spatial
• Node
• Object

Methods

impl Skeleton

Constants

pub const NOTIFICATION_UPDATE_SKELETON: i64

impl Skeleton

pub fn new() -> Skeleton

Constructor.

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 Skeleton::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn add_bone(&mut self, name: GodotString)

pub unsafe fn bind_child_node_to_bone(
    &mut self,
    bone_idx: i64,
    node: Option<Node>
)

pub unsafe fn clear_bones(&mut self)

pub unsafe fn find_bone(&self, name: GodotString) -> i64

pub unsafe fn get_bone_count(&self) -> i64

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

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

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

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

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

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

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

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

pub unsafe fn localize_rests(&mut self)

pub unsafe fn physical_bones_add_collision_exception(&mut self, exception: Rid)

pub unsafe fn physical_bones_remove_collision_exception(
    &mut self,
    exception: Rid
)

pub unsafe fn physical_bones_start_simulation(&mut self, bones: VariantArray)

pub unsafe fn physical_bones_stop_simulation(&mut self)

pub unsafe fn register_skin(
    &mut self,
    skin: Option<Skin>
) -> Option<SkinReference>

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

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

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

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

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

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

pub unsafe fn unbind_child_node_from_bone(
    &mut self,
    bone_idx: i64,
    node: Option<Node>
)

pub unsafe fn unparent_bone_and_rest(&mut self, bone_idx: i64)

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

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 unsafe fn _update_gizmo(&mut self)

pub unsafe fn force_update_transform(&mut self)

pub unsafe fn get_gizmo(&self) -> Option<SpatialGizmo>

pub unsafe fn get_global_transform(&self) -> Transform

pub unsafe fn get_parent_spatial(&self) -> Option<Spatial>

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

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

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

pub unsafe fn get_transform(&self) -> Transform

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

pub unsafe fn get_world(&self) -> Option<World>

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

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

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

pub unsafe fn hide(&mut self)

pub unsafe fn is_local_transform_notification_enabled(&self) -> bool

pub unsafe fn is_scale_disabled(&self) -> bool

pub unsafe fn is_set_as_toplevel(&self) -> bool

pub unsafe fn is_transform_notification_enabled(&self) -> bool

pub unsafe fn is_visible(&self) -> bool

pub unsafe fn is_visible_in_tree(&self) -> bool

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

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

pub unsafe fn orthonormalize(&mut self)

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

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

pub unsafe fn rotate_x(&mut self, angle: f64)

pub unsafe fn rotate_y(&mut self, angle: f64)

pub unsafe fn rotate_z(&mut self, angle: f64)

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

pub unsafe fn set_as_toplevel(&mut self, enable: bool)

pub unsafe fn set_disable_scale(&mut self, disable: bool)

pub unsafe fn set_gizmo(&mut self, gizmo: Option<SpatialGizmo>)

pub unsafe fn set_global_transform(&mut self, global: Transform)

pub unsafe fn set_identity(&mut self)

pub unsafe fn set_ignore_transform_notification(&mut self, enabled: bool)

pub unsafe fn set_notify_local_transform(&mut self, enable: bool)

pub unsafe fn set_notify_transform(&mut self, enable: bool)

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

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

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

pub unsafe fn set_transform(&mut self, local: Transform)

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

pub unsafe fn set_visible(&mut self, visible: bool)

pub unsafe fn show(&mut self)

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

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

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

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

pub unsafe fn update_gizmo(&mut self)

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for Skeleton

fn clone(&self) -> Skeleton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Skeleton

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 Free for Skeleton

unsafe fn godot_free(self)

impl FromVariant for Skeleton

fn from_variant(variant: &Variant) -> Result<Skeleton, FromVariantError>

impl GodotObject for Skeleton

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> Skeleton

unsafe fn from_return_position_sys(obj: *mut c_void) -> Skeleton

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for Skeleton

fn construct() -> Skeleton

impl QueueFree for Skeleton

unsafe fn godot_queue_free(&mut self)

impl ToVariant for Skeleton

fn to_variant(&self) -> Variant