Struct ARBodyTrackingConfiguration

Source

pub struct ARBodyTrackingConfiguration { /* private fields */ }

Available on crate features ARConfiguration and objc2 only.

Expand description

A configuration for running body tracking.

Body tracking provides 6 degrees of freedom tracking of a detected body in the scene. By default, ARFrameSemanticBodyDetection will be enabled.

See: ARBodyAnchor

See: -[ARFrame detectedBody]

Implementations§

Source §

impl ARBodyTrackingConfiguration

Source

pub unsafe fn isAutoFocusEnabled(&self) -> bool

Enable or disable continuous auto focus.

Enabled by default.

Source

pub unsafe fn setAutoFocusEnabled(&self, auto_focus_enabled: bool)

Setter for isAutoFocusEnabled.

Source

pub unsafe fn initialWorldMap(&self) -> Option<Retained<ARWorldMap>>

Available on crate feature ARWorldMap only.

The initial map of the physical space that world tracking will localize to and track.

If set, the session will attempt to localize to the provided map with a limited tracking state until localization is successful or run is called again with a different (or no) initial map specified. Once localized, the map will be extended and can again be saved using the getCurrentWorldMap method on the session.

Source

pub unsafe fn setInitialWorldMap(&self, initial_world_map: Option<&ARWorldMap>)

Available on crate feature ARWorldMap only.

Setter for initialWorldMap.

Source

pub unsafe fn environmentTexturing(&self) -> AREnvironmentTexturing

The mode of environment texturing to run.

If set, texture information will be accumulated and updated. Adding an AREnvironmentProbeAnchor to the session will get the current environment texture available from that probe’s perspective which can be used for lighting virtual objects in the scene. Defaults to AREnvironmentTexturingNone.

Source

pub unsafe fn setEnvironmentTexturing( &self, environment_texturing: AREnvironmentTexturing, )

Setter for environmentTexturing.

Source

pub unsafe fn wantsHDREnvironmentTextures(&self) -> bool

Determines whether environment textures will be provided with high dynamic range. Enabled by default.

Source

pub unsafe fn setWantsHDREnvironmentTextures( &self, wants_hdr_environment_textures: bool, )

Setter for wantsHDREnvironmentTextures.

Source

pub unsafe fn planeDetection(&self) -> ARPlaneDetection

Available on crate feature ARPlaneDetectionTypes only.

Type of planes to detect in the scene.

If set, new planes will continue to be detected and updated over time. Detected planes will be added to the session as ARPlaneAnchor objects. In the event that two planes are merged, the newer plane will be removed. Defaults to ARPlaneDetectionNone.

Source

pub unsafe fn setPlaneDetection(&self, plane_detection: ARPlaneDetection)

Available on crate feature ARPlaneDetectionTypes only.

Setter for planeDetection.

Source

pub unsafe fn detectionImages(&self) -> Retained<NSSet<ARReferenceImage>>

Available on crate features ARReferenceImage and objc2-foundation only.

Images to detect in the scene.

If set the session will attempt to detect the specified images. When an image is detected an ARImageAnchor will be added to the session.

Source

pub unsafe fn setDetectionImages( &self, detection_images: &NSSet<ARReferenceImage>, )

Available on crate features ARReferenceImage and objc2-foundation only.

Setter for detectionImages.

This is copied when set.

Source

pub unsafe fn automaticImageScaleEstimationEnabled(&self) -> bool

Enables the estimation of a scale factor which may be used to correct the physical size of an image.

If set to true ARKit will attempt to use the computed camera positions in order to compute the scale by which the given physical size differs from the estimated one. The information about the estimated scale can be found as the property estimatedScaleFactor on the ARImageAnchor.

Note: When set to true the transform of a returned ARImageAnchor will use the estimated scale factor to correct the translation. Default value is NO.

Source

pub unsafe fn setAutomaticImageScaleEstimationEnabled( &self, automatic_image_scale_estimation_enabled: bool, )

Setter for automaticImageScaleEstimationEnabled.

Source

pub unsafe fn automaticSkeletonScaleEstimationEnabled(&self) -> bool

Enables the estimation of a scale factor which may be used to correct the physical size of a skeleton in 3D.

If set to true ARKit will attempt to use the computed camera positions in order to compute the scale by which the given physical size differs from the default one. The information about the estimated scale can be found as the property estimatedScaleFactor on the ARBodyAnchor.

Note: When set to true the transform of a returned ARBodyAnchor will use the estimated scale factor to correct the translation. Default value is NO.

Source

pub unsafe fn setAutomaticSkeletonScaleEstimationEnabled( &self, automatic_skeleton_scale_estimation_enabled: bool, )

Setter for automaticSkeletonScaleEstimationEnabled.

Source

pub unsafe fn maximumNumberOfTrackedImages(&self) -> NSInteger

Maximum number of images to track simultaneously.

Setting the maximum number of tracked images will limit the number of images that can be tracked in a given frame. If more than the maximum is visible, only the images already being tracked will continue to track until tracking is lost or another image is removed. Images will continue to be detected regardless of images tracked. Default value is zero.

Source

pub unsafe fn setMaximumNumberOfTrackedImages( &self, maximum_number_of_tracked_images: NSInteger, )

Setter for maximumNumberOfTrackedImages.

Source

pub unsafe fn appClipCodeTrackingEnabled(&self) -> bool

Enable or disable app clip code tracking. Disabled by default. When enabled, detected app clip codes will be surfaced as an ARAppClipCodeAnchor.

Source

pub unsafe fn setAppClipCodeTrackingEnabled( &self, app_clip_code_tracking_enabled: bool, )

Setter for appClipCodeTrackingEnabled.

Source

pub unsafe fn supportsAppClipCodeTracking() -> bool

Indicates whether app clip code tracking can be enabled on this device.

Source

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

Source

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

Methods from Deref<Target = ARConfiguration>§

Source

pub unsafe fn videoFormat(&self) -> Retained<ARVideoFormat>

Available on crate feature ARVideoFormat only.

Video format of the session output.

Source

pub unsafe fn setVideoFormat(&self, video_format: &ARVideoFormat)

Available on crate feature ARVideoFormat only.

Setter for videoFormat.

Source

pub unsafe fn worldAlignment(&self) -> ARWorldAlignment

Determines how the coordinate system should be aligned with the world.

The default is ARWorldAlignmentGravity.

Source

pub unsafe fn setWorldAlignment(&self, world_alignment: ARWorldAlignment)

Setter for worldAlignment.

Source

pub unsafe fn isLightEstimationEnabled(&self) -> bool

Enable or disable light estimation.

Enabled by default.

Source

pub unsafe fn setLightEstimationEnabled(&self, light_estimation_enabled: bool)

Setter for isLightEstimationEnabled.

Source

pub unsafe fn providesAudioData(&self) -> bool

Determines whether to capture and provide audio data.

Disabled by default.

Source

pub unsafe fn setProvidesAudioData(&self, provides_audio_data: bool)

Setter for providesAudioData.

Source

pub unsafe fn frameSemantics(&self) -> ARFrameSemantics

The type of semantic understanding to provide with each frame.

Use the supportsFrameSemantics class method to check if the configuration type you intend to run supports the set of frame semantics. For example, when running a session with a configuration of type ARWorldTrackingConfiguration one would need to use +[ ARWorldTrackingConfiguration supportsFrameSemantics:] to perform said check. An exception is thrown if the option is not supported. Defaults to ARFrameSemanticNone.

See: ARFrameSemantics

See: +[ARConfiguration supportsFrameSemantics:]

Source

pub unsafe fn setFrameSemantics(&self, frame_semantics: ARFrameSemantics)

Setter for frameSemantics.

Source

pub unsafe fn videoHDRAllowed(&self) -> bool

Whether HDR capturing is allowed if the current video format supports it. Defaults to NO.

Source

pub unsafe fn setVideoHDRAllowed(&self, video_hdr_allowed: bool)

Setter for videoHDRAllowed.

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