Struct SCNSkinner

Source

#[repr(C)]
pub struct SCNSkinner { /* private fields */ }

Available on crate feature SCNSkinner only.

Expand description

SCNSkinner controls the deformation of skinned geometries

Implementations§

Source §

impl SCNSkinner

Source

pub unsafe fn skeleton(&self) -> Option<Retained<SCNNode>>

Available on crate feature SCNNode only.

Specifies the skeleton of the receiver.

When setting a new skeleton, the new skeleton must have the same hierarchy of joints.

Source

pub unsafe fn setSkeleton(&self, skeleton: Option<&SCNNode>)

Available on crate feature SCNNode only.

This is a weak property. Setter for skeleton.

Source

pub unsafe fn skinnerWithBaseGeometry_bones_boneInverseBindTransforms_boneWeights_boneIndices( base_geometry: Option<&SCNGeometry>, bones: &NSArray<SCNNode>, bone_inverse_bind_transforms: Option<&NSArray<NSValue>>, bone_weights: &SCNGeometrySource, bone_indices: &SCNGeometrySource, ) -> Retained<Self>

Available on crate features SCNGeometry and SCNNode only.

Creates and initialize a skinner instance with the specified parameters.

Parameter baseGeometry: Specifies the base geometry used by the skinner

Parameter bones: Specifies the array of bones.

Parameter boneInverseBindTransforms: The inverse of the bone’s bind-space transformation matrix at the time the bind shape was bound to this bone.

Parameter boneWeights: A buffer of weights. This contains the weights of every influence of every vertex. The number of influence per vertex is controlled by the number of component in the geometry source.

Parameter boneIndices: A buffer of bone indexes. This buffer contains the corresponding index in the bones array for every weight in the weights buffer.

Source

pub unsafe fn baseGeometry(&self) -> Option<Retained<SCNGeometry>>

Available on crate feature SCNGeometry only.

Specifies the base geometry of the receiver.

Updating this will change the geometry of all the nodes sharing the skinner. Access the node’s geometry if you want to update this specific skinner properties (materials for example). Access this property if you want a whole new geometry (which will necessarily be shared among the skinner instances), with different sources, for instance.

Source

pub unsafe fn setBaseGeometry(&self, base_geometry: Option<&SCNGeometry>)

Available on crate feature SCNGeometry only.

Setter for baseGeometry.

Source

pub unsafe fn baseGeometryBindTransform(&self) -> SCNMatrix4

Available on crate feature SceneKitTypes and crate feature objc2-quartz-core and non-watchOS only.

Specifies the transform of the baseGeometry at the time when the mesh was bound to a skeleton. This transforms the baseGeometry from object space to a space on which the skinning then applies.

Source

pub unsafe fn setBaseGeometryBindTransform( &self, base_geometry_bind_transform: SCNMatrix4, )

Available on crate feature SceneKitTypes and crate feature objc2-quartz-core and non-watchOS only.

Setter for baseGeometryBindTransform.

Source

pub unsafe fn boneInverseBindTransforms( &self, ) -> Option<Retained<NSArray<NSValue>>>

The inverse of the bone’s bind-space transformation matrix at the time the bind shape was bound to this bone.

boneInverseBindTransforms is an array of SCNMatrix4 wrapped into instances of NSValue.

Source

pub unsafe fn bones(&self) -> Retained<NSArray<SCNNode>>

Available on crate feature SCNNode only.

The bones of the skinner.

Source

pub unsafe fn boneWeights(&self) -> Retained<SCNGeometrySource>

Available on crate feature SCNGeometry only.

The bone weights of the receiver.

Source

pub unsafe fn boneIndices(&self) -> Retained<SCNGeometrySource>

Available on crate feature SCNGeometry only.

The bone indices of the receiver.

Source §

impl SCNSkinner

Methods declared on superclass NSObject.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}