Struct VNFaceLandmarks2D

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

Available on crate feature VNFaceLandmarks only.

VNFaceLandmarks2D is the result of a face landmarks 2D request, containing detected facial landmark points organized into VNFaceLandmarkRegion2D regions. The points are accessible as a full list, or as sub-gruops representing pre-defined facial regions.

See also Apple’s documentation

Implementations

impl VNFaceLandmarks2D

pub unsafe fn allPoints(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

allPoints the region containing all face landmark points.

pub unsafe fn faceContour(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

faceContour the region containing the points that describe the face contour from cheek over chin to cheek.

pub unsafe fn leftEye(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

leftEye the region containing the points describing the outline of the left eye.

pub unsafe fn rightEye(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

rightEye the region containing the points describing the outline of the right eye.

pub unsafe fn leftEyebrow(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

leftEyebrow the region containing the points describing the trace of the left eyebrow.

pub unsafe fn rightEyebrow(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

rightEyebrow the region containing the points describing the trace of the right eyebrow.

pub unsafe fn nose(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

nose the region containing the points describing the outline of the nose.

pub unsafe fn noseCrest(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

noseCrest the region containing the points describing the trace of the center crest of the nose.

pub unsafe fn medianLine(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

medianLine the region containing the points describing the trace of the center line of the face.

pub unsafe fn outerLips(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

outer lips the region containing the points describing the outline of the outside of the lips.

pub unsafe fn innerLips(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

innerLips the region containing the points describing the outline of the space between the of the lips.

pub unsafe fn leftPupil(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

leftPupil the region containing the point where the left pupil is located. This value may be inaccurate if the face isBlinking.

pub unsafe fn rightPupil(&self) -> Option<Retained<VNFaceLandmarkRegion2D>>

rightPupil the region containing the point where the right pupil is located. This value may be inaccurate if the face isBlinking.

impl VNFaceLandmarks2D

Methods declared on superclass VNFaceLandmarks.

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

impl VNFaceLandmarks2D

Methods declared on superclass NSObject.

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

Methods from Deref<Target = VNFaceLandmarks>

pub unsafe fn confidence(&self) -> VNConfidence

Available on crate feature VNTypes only.

a confidence estimate for the returned landmarks.

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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

Trait Implementations

impl AsRef<AnyObject> for VNFaceLandmarks2D

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for VNFaceLandmarks2D

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<VNFaceLandmarks> for VNFaceLandmarks2D

fn as_ref(&self) -> &VNFaceLandmarks

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<VNFaceLandmarks2D> for VNFaceLandmarks2D

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for VNFaceLandmarks2D

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for VNFaceLandmarks2D

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<VNFaceLandmarks> for VNFaceLandmarks2D

fn borrow(&self) -> &VNFaceLandmarks

Immutably borrows from an owned value.

impl ClassType for VNFaceLandmarks2D

const NAME: &'static str = "VNFaceLandmarks2D"

The name of the Objective-C class that this type represents.

type Super = VNFaceLandmarks

The superclass of this class.

type ThreadKind = <<VNFaceLandmarks2D as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for VNFaceLandmarks2D

type Result = VNFaceLandmarks2D

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for VNFaceLandmarks2D

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

Formats the value using the given formatter.

impl Deref for VNFaceLandmarks2D

type Target = VNFaceLandmarks

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for VNFaceLandmarks2D

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for VNFaceLandmarks2D

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for VNFaceLandmarks2D

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for VNFaceLandmarks2D

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for VNFaceLandmarks2D

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for VNFaceLandmarks2D

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for VNFaceLandmarks2D

const ENCODING_REF: Encoding = <VNFaceLandmarks as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl VNRequestRevisionProviding for VNFaceLandmarks2D

unsafe fn requestRevision(&self) -> NSUInteger

where Self: Sized + Message,

Available on crate feature VNRequestRevisionProviding only.

The revision of the VNRequest subclass that was used to generate the object that implements this protocol.

impl DowncastTarget for VNFaceLandmarks2D

impl Eq for VNFaceLandmarks2D

impl NSCoding for VNFaceLandmarks2D