Struct ARSkeletonDefinition

Source

pub struct ARSkeletonDefinition { /* private fields */ }

Available on crate features ARSkeletonDefinition and objc2 only.

Expand description

Definition of a skeleton.

A skeleton consists of a set of labeled joints that are defined in a certain hierarchy, i.e. joints are parented to other joints. One may use the parentIndices property to identify the hierarchy for a given skeleton definition.

Implementations§

Source §

impl ARSkeletonDefinition

Source

pub unsafe fn defaultBody3DSkeletonDefinition() -> Retained<ARSkeletonDefinition>

Default skeleton definition for bodies defined in 3D.

Note: The default height of this skeleton, measured from lowest to highest joint in standing position, is defined to be 1.71 meters.

See: ARSkeleton3D

Source

pub unsafe fn defaultBody2DSkeletonDefinition() -> Retained<ARSkeletonDefinition>

Default skeleton definition for bodies defined in 2D.

See: ARBody2D

Source

pub unsafe fn jointCount(&self) -> NSUInteger

The number of joints.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn jointNames(&self) -> Retained<NSArray<NSString>>

Available on crate feature objc2-foundation only.

The joint names.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn parentIndices(&self) -> Retained<NSArray<NSNumber>>

Available on crate feature objc2-foundation only.

The parent index for each joint.

This property may be used to identify the hierarchical dependency between joints. If a line is drawn for every joint and its parent joint the result is a visualization of the underlying skeleton. The joint with no parent is denoted as the root joint. The root joint’s parent index has a value of -1.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn neutralBodySkeleton3D(&self) -> Option<Retained<ARSkeleton3D>>

Available on crate feature ARSkeleton only.

The 3D skeleton in neutral pose.

The neutral skeleton pose assumes a standardized size of the skeleton in meters. The neutral pose is defined as the skeleton’s T-pose.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn indexForJointName( &self, joint_name: &ARSkeletonJointName, ) -> NSUInteger

Available on crate feature objc2-foundation only.

Returns the index for a given joint identifier.

Parameter jointName: Name of a given joint.

This function returns NSNotFound if an invalid joint name is passed.

Returns: Joint index.

Source

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

Unavailable

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.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§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`
    }
}