Struct VNHumanBodyPoseObservation

Source

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

Available on crate features VNDetectHumanBodyPoseRequest and VNObservation only.

Expand description

Apple’s documentation

Implementations§

Source §

impl VNHumanBodyPoseObservation

Source

pub unsafe fn availableJointNames( &self, ) -> Retained<NSArray<VNHumanBodyPoseObservationJointName>>

Available on crate feature VNTypes only.

All of the joint names available in the observation.

Source

pub unsafe fn availableJointsGroupNames( &self, ) -> Retained<NSArray<VNHumanBodyPoseObservationJointsGroupName>>

Available on crate feature VNTypes only.

All of the joints group names available in the observation.

Source

pub unsafe fn recognizedPointForJointName_error( &self, joint_name: &VNHumanBodyPoseObservationJointName, ) -> Result<Retained<VNRecognizedPoint>, Retained<NSError>>

Available on crate features VNDetectedPoint and VNGeometry and VNTypes only.

Obtain a specific normalized point for a named human body joint.

Parameter jointName: The name of the human body joint.

Parameter error: The address of a variable that will be populated with the error that describes the failure. If the caller does not require this information, NULL can be passed.

Returns: the recognized point, or nil if the point could not be obtained.

Source

pub unsafe fn recognizedPointsForJointsGroupName_error( &self, joints_group_name: &VNHumanBodyPoseObservationJointsGroupName, ) -> Result<Retained<NSDictionary<VNHumanBodyPoseObservationJointName, VNRecognizedPoint>>, Retained<NSError>>

Available on crate features VNDetectedPoint and VNGeometry and VNTypes only.

Obtains the collection of points associated with a named human body joints group.

The obtained collection is a dictionary that provides the mapping of human body join names to the recognized point.

Parameter jointsGroupName: The name of the human body joints group.

Parameter error: The address of a variable that will be populated with the error that describes the failure. If the caller does not require this information, NULL can be passed.

Returns: a dictionary of recognized points in the group, or nil if an error was encountered.

Source §

impl VNHumanBodyPoseObservation

Methods declared on superclass VNRecognizedPointsObservation.

Source

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

Source

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

Methods from Deref<Target = VNRecognizedPointsObservation>§

Source

pub unsafe fn availableKeys(&self) -> Retained<NSArray<VNRecognizedPointKey>>

Available on crate feature VNTypes only.

Returns all of the point group keys available in the observation.

Source

pub unsafe fn availableGroupKeys( &self, ) -> Retained<NSArray<VNRecognizedPointGroupKey>>

Available on crate feature VNTypes only.

The availableGroupKeys property returns all of the point group labels usable with the observation.

Source

pub unsafe fn recognizedPointForKey_error( &self, point_key: &VNRecognizedPointKey, ) -> Result<Retained<VNRecognizedPoint>, Retained<NSError>>

Available on crate features VNDetectedPoint and VNGeometry and VNTypes only.

Obtains a specific normalized recognized point.

Parameter pointKey: The key specifying the desired recognized point.

Parameter error: The address of a variable that will be populated with the error that describes the failure. If the caller does not require this information, NULL can be passed.

Returns: the recognized point, or nil if the specific point is not defined.

Source

pub unsafe fn recognizedPointsForGroupKey_error( &self, group_key: &VNRecognizedPointGroupKey, ) -> Result<Retained<NSDictionary<VNRecognizedPointKey, VNRecognizedPoint>>, Retained<NSError>>

Available on crate features VNDetectedPoint and VNGeometry and VNTypes only.

Obtains the collection of points associated with an identified grouping.

The obtained collection is a dictionary that provides the mapping of a recognized point’s key to the recognized point.

Parameter groupKey: The key representing a specific grouping of points.

Parameter error: The address of a variable that will be populated with the error that describes the failure. If the caller does not require this information, NULL can be passed.

Returns: the dictionary of recognized points in the group, or nil if an error was encountered.

Source

pub unsafe fn keypointsMultiArrayAndReturnError( &self, ) -> Result<Retained<MLMultiArray>, Retained<NSError>>

Available on crate feature objc2-core-ml only.

Returns the recognized points packaged into an MLMultiArray.

The MLMultiArray will contain the raw data output of (x coordinate, y coordinate, confidence) for specific points in the format expected by CreateML action recognition models. The datatype of the elements in the array is double and the dimensions are [1, 3, # of possible points]. If an expected point key is not available in the obeservation, that entry in the MLMultiArray will be populated with 0s.

Parameter error: The address of a variable that will be populated with the error that describes the failure. If the caller does not require this information, NULL can be passed.

Returns: the MLMultiArray representation of the points, or nil if an error was encountered.

Methods from Deref<Target = VNObservation>§

Source

pub unsafe fn uuid(&self) -> Retained<NSUUID>

The unique identifier assigned to an observation.

Source

pub unsafe fn confidence(&self) -> VNConfidence

Available on crate feature VNTypes only.

The level of confidence normalized to [0, 1] where 1 is most confident. The only exception is results coming from VNCoreMLRequest, where confidence values are forwarded as is from relevant CoreML models

Confidence can always be returned as 1.0 if confidence is not supported or has no meaning

Source

pub unsafe fn timeRange(&self) -> CMTimeRange

Available on crate feature objc2-core-media only.

The duration of the observation reporting when first detected and how long it is valid.

The duration of the observation when used with a sequence of buffers. If a request does not support a timeRange or the timeRange is not known, the start time and duration will be set to 0.

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