Struct VNHumanObservation

Source

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

Available on crate feature VNObservation only.

Expand description

VNHumanObservation is the result of a Human rectangles detection request

Implementations§

Source §

impl VNHumanObservation

Source

pub unsafe fn upperBodyOnly(&self) -> bool

Boolean property to specify whether the human upper body or full body detection is recorded in the observation. This setting is propagated from [VNDetectHumanRectanglesRequest -upperBodyOnly]

Source §

impl VNHumanObservation

Methods declared on superclass VNDetectedObjectObservation.

Source

pub unsafe fn observationWithBoundingBox(bounding_box: CGRect) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

create a new VNDetectedObjectObservation with a normalized bounding box and a confidence of 1.0.

Source

pub unsafe fn observationWithRequestRevision_boundingBox( request_revision: NSUInteger, bounding_box: CGRect, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Source §

impl VNHumanObservation

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 = VNDetectedObjectObservation>§

Source

pub unsafe fn boundingBox(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

The bounding box of the detected object. The coordinates are normalized to the dimensions of the processed image, with the origin at the image’s lower-left corner.

Source

pub unsafe fn globalSegmentationMask( &self, ) -> Option<Retained<VNPixelBufferObservation>>

The resulting CVPixelBuffer from requests that generate a segmentation mask for the entire image.

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