Struct rusty_spine::Skeleton

pub struct Skeleton { /* private fields */ }

A live Skeleton instance created from SkeletonData.

Spine API Reference

Implementations

impl Skeleton

pub fn new(skeleton_data: Arc<SkeletonData>) -> Self

Create a new instance of the skeleton loaded in SkeletonData.

See SkeletonJson or SkeletonBinary for a complete example of loading a skeleton.

pub fn update_cache(&mut self)

Caches information about bones and constraints. Must be called if the skin is modified or if bones, constraints, or weighted path attachments are added or removed.

pub fn update_world_transform(&mut self)

Updates the world transform for each bone and applies all constraints.

See World transforms in the Spine Runtimes Guide.

pub unsafe fn update_world_transform_with(&mut self, parent: &Bone)

Temporarily sets the root bone as a child of the specified bone, then updates the world transform for each bone and applies all constraints.

See World transforms in the Spine Runtimes Guide.

Safety

The bone must originate from this skeleton.

pub fn set_to_setup_pose(&mut self)

Sets the bones, constraints, slots, and draw order to their setup pose values.

pub fn set_bones_to_setup_pose(&mut self)

Sets the bones and constraints to their setup pose values.

pub fn set_slots_to_setup_pose(&mut self)

Sets the slots and draw order to their setup pose values.

pub unsafe fn set_skin(&mut self, skin: &Skin)

Set the skeleton’s skin. If the skin is a user-created one (via Skin::new), then a clone is created and used instead, to help ensure memory safety. If this behavior is not desired then Skeleton::set_skin_unchecked can be used instead.

Safety

The skin must originate from the same SkeletonData that this skeleton uses.

pub unsafe fn set_skin_unchecked(&mut self, skin: &Skin)

Set the skeleton’s skin.

Safety

The skin must originate from the same SkeletonData that this skeleton uses.

The Skin struct will destroy the underlying C representation of the skin in its Drop implementation. Skins assigned to a skeleton must live as long as the skeletons using them or else the skeleton may cause a segfault.

pub unsafe fn set_skin_by_name_unchecked(&mut self, skin_name: &str)

Set the skeleton’s skin by name.

Safety

This function should only be called with valid skin names. It is faster than the safe alternative, Skeleton::set_skin_by_name, but will likely segfault if the skin does not exist.

pub fn set_skin_by_name(&mut self, skin_name: &str) -> Result<(), SpineError>

Set the skeleton’s skin by name.

Errors

Returns SpineError::NotFound if the specified skin name doesn’t exist.

pub fn set_skins_by_name<'a, T>( &mut self, combined_skin_name: &str, skin_names: impl IntoIterator<Item = T> ) -> Result<(), SpineError>

where Cow<'a, str>: From<T>,

Create a conglomerate skin containing skin_names and attach to this skeleton.

skeleton.set_skins_by_name("combined-skin", ["hat", "suit", "tie"]);

The name assigned to this skin (via combined_skin_name) is unimportant and does not need to be unique.

A faster (but unsafe) way to create conglomerate skins is to use Skin::new and Skin::add_skin to create a pre-configured skin that can be attached at any time with Skeleton::set_skin.

Errors

Returns SpineError::NotFound if any of the specified skin names do not exist (in this case, the current skin remains unchanged).

pub fn bone_root(&self) -> CTmpRef<'_, Skeleton, Bone>

The root bone, or None if the skeleton has no bones.

pub fn bone_root_mut(&mut self) -> CTmpMut<'_, Skeleton, Bone>

The mutable root bone, or None if the skeleton has no bones.

pub fn find_bone(&self, name: &str) -> Option<CTmpRef<'_, Skeleton, Bone>>

pub fn find_bone_mut( &mut self, name: &str ) -> Option<CTmpMut<'_, Skeleton, Bone>>

pub fn find_slot(&self, name: &str) -> Option<CTmpRef<'_, Skeleton, Slot>>

pub fn find_slot_mut( &mut self, name: &str ) -> Option<CTmpMut<'_, Skeleton, Slot>>

pub fn set_attachment( &mut self, slot_name: &str, attachment_name: Option<&str> ) -> bool

pub fn get_attachment_for_slot_name( &mut self, slot_name: &str, attachment_name: &str ) -> Option<Attachment>

pub fn get_attachment_for_slot_index( &mut self, slot_index: usize, attachment_name: &str ) -> Option<Attachment>

pub fn data(&self) -> CTmpRef<'_, Self, SkeletonData>

The skeleton’s setup pose data.

pub fn data_mut(&mut self) -> CTmpMut<'_, Self, SkeletonData>

The skeleton’s mutable setup pose data.

pub fn color(&self) -> Color

The color to tint all the skeleton’s attachments.

pub fn color_mut(&mut self) -> &mut Color

Set the color to tint all the skeleton’s attachments.

pub fn bones_count(&self) -> usize

The number of bones in this skeleton.

pub fn slots_count(&self) -> usize

The number of slots in this skeleton.

pub fn ik_contraints_count(&self) -> usize

The number of IK constraints in this skeleton.

pub fn transform_contraints_count(&self) -> usize

The number of transform constraints in this skeleton.

pub fn path_contraints_count(&self) -> usize

The number of path constraints in this skeleton.

pub fn scale_x(&self) -> f32

Scales the entire skeleton on the X axis.

pub fn set_scale_x(&mut self, value: f32)

Sets the scale the entire skeleton on the X axis. Bones that do not inherit scale are still affected by this property.

pub fn scale_y(&self) -> f32

Scales the entire skeleton on the Y axis.

pub fn set_scale_y(&mut self, value: f32)

Sets the scale the entire skeleton on the Y axis. Bones that do not inherit scale are still affected by this property.

pub fn x(&self) -> f32

The skeleton X position, which is added to the root bone worldX position.

pub fn set_x(&mut self, value: f32)

Sets the skeleton X position, which is added to the root bone worldX position. Bones that do not inherit translation are still affected by this property.

pub fn y(&self) -> f32

The skeleton Y position, which is added to the root bone worldY position.

pub fn set_y(&mut self, value: f32)

Sets the skeleton Y position, which is added to the root bone worldY position. Bones that do not inherit translation are still affected by this property.

pub fn bones(&self) -> CTmpPtrIterator<'_, Skeleton, Bone, spBone>

An iterator to the skeleton’s bones.

pub fn bone_at_index(&self, index: usize) -> Option<CTmpRef<'_, Self, Bone>>

The nth bone in the skeleton.

pub fn bones_mut(&mut self) -> CTmpMutIterator<'_, Skeleton, Bone, spBone>

A mutable iterator to the skeleton’s bones.

pub fn bone_at_index_mut( &mut self, index: usize ) -> Option<CTmpMut<'_, Self, Bone>>

The nth mutable bone in the skeleton.

pub fn slots(&self) -> CTmpPtrIterator<'_, Skeleton, Slot, spSlot>

An iterator to the skeleton’s slots.

pub fn slot_at_index(&self, index: usize) -> Option<CTmpRef<'_, Self, Slot>>

The nth slot in the skeleton.

pub fn slots_mut(&mut self) -> CTmpMutIterator<'_, Skeleton, Slot, spSlot>

A mutable iterator to the skeleton’s slots.

pub fn slot_at_index_mut( &mut self, index: usize ) -> Option<CTmpMut<'_, Self, Slot>>

The nth mutable slot in the skeleton.

pub fn draw_order(&self) -> CTmpPtrIterator<'_, Skeleton, Slot, spSlot>

An iterator to the skeleton’s slots in the order they should be drawn.

pub fn draw_order_at_index( &self, index: usize ) -> Option<CTmpRef<'_, Self, Slot>>

The nth skeleton slot, indexed in the order they should be drawn.

pub fn draw_order_mut(&mut self) -> CTmpMutIterator<'_, Skeleton, Slot, spSlot>

A mutable iterator to the skeleton’s slots in the order they should be drawn.

pub fn draw_order_at_index_mut( &mut self, index: usize ) -> Option<CTmpMut<'_, Self, Slot>>

The nth mutable skeleton slot, indexed in the order they should be drawn.

pub fn skin(&self) -> Option<CTmpRef<'_, Self, Skin>>

pub fn skin_mut(&mut self) -> Option<CTmpMut<'_, Self, Skin>>

pub const fn c_ptr(&self) -> *mut spSkeleton

Get a pointer to the underlying spine-c type.

impl Skeleton

Functions available if using the mint feature.

pub fn position(&self) -> Vector2<f32>

pub fn set_position(&mut self, position: impl Into<Vector2<f32>>)

pub fn scale(&self) -> Vector2<f32>

pub fn set_scale(&mut self, scale: impl Into<Vector2<f32>>)

Trait Implementations

impl Debug for Skeleton

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

Formats the value using the given formatter.

impl Drop for Skeleton

fn drop(&mut self)

Executes the destructor for this type.