Struct ARGeoAnchor

Source

pub struct ARGeoAnchor { /* private fields */ }

Available on crate features ARAnchor and ARGeoAnchor and objc2 only.

Expand description

An anchor representing a geographical location in the world.

The anchor’s transform will be automatically updated by the session based on location and heading. The session needs to be configured with ARGeoTrackingConfiguration.

Implementations§

Source §

impl ARGeoAnchor

Source

pub unsafe fn coordinate(&self) -> CLLocationCoordinate2D

Available on crate feature objc2-core-location only.

The coordinate where this anchor will be placed.

The anchor’s transform will be automatically updated by the session when ARGeoTrackingConfiguration is set.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn altitude(&self) -> CLLocationDistance

Available on crate feature objc2-core-location only.

The distance to mean sea level, in meters (negative values indicate it’s below sea level).

Only valid when altitudeSource is not ARAltitudeSourceUnknown.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn altitudeSource(&self) -> ARAltitudeSource

Available on crate feature ARGeoTrackingTypes only.

The source of altitude information. If the user did not provide the altitude, ARKit populates this property to indicate the expected accuracy depending on the available altitude data.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn initWithCoordinate( this: Allocated<Self>, coordinate: CLLocationCoordinate2D, ) -> Retained<Self>

Available on crate feature objc2-core-location only.

Initializes a new ARGeoAnchor with the given coordinates.

ARKit will query the ground level altitude during runtime, and populate the altitude as soon as that information becomes available.

Parameter coordinate: Coordinates.

Source

pub unsafe fn initWithCoordinate_altitude( this: Allocated<Self>, coordinate: CLLocationCoordinate2D, altitude: CLLocationDistance, ) -> Retained<Self>

Available on crate feature objc2-core-location only.

Initializes a new ARGeoAnchor with the given coordinates and altitude.

Parameter coordinate: Coordinates.

Parameter altitude: Altitude in meters.

Source

pub unsafe fn initWithName_coordinate( this: Allocated<Self>, name: &NSString, coordinate: CLLocationCoordinate2D, ) -> Retained<Self>

Available on crate features objc2-core-location and objc2-foundation only.

Initializes a new named ARGeoAnchor with the given coordinates.

ARKit will query the ground level altitude during runtime, and populate the altitude as soon as that information becomes available.

Parameter name: Name of the anchor.

Parameter coordinate: Coordinates.

Source

pub unsafe fn initWithName_coordinate_altitude( this: Allocated<Self>, name: &NSString, coordinate: CLLocationCoordinate2D, altitude: CLLocationDistance, ) -> Retained<Self>

Available on crate features objc2-core-location and objc2-foundation only.

Initializes a new named ARGeoAnchor with the given coordinates and altitude.

Parameter name: Name of the anchor.

Parameter coordinate: Coordinates.

Parameter altitude: Altitude in meters.

Source §

impl ARGeoAnchor

Methods declared on superclass ARAnchor.

Source

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

Unavailable

Source

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

Methods from Deref<Target = ARAnchor>§

Source

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

Available on crate feature objc2-foundation only.

Unique identifier of the anchor.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn name(&self) -> Option<Retained<NSString>>

Available on crate feature objc2-foundation only.

An optional name used to associate with the anchor.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

Available on crate feature objc2-foundation only.

Identifier of the session that owns the anchor.

The session identifier will be assigned to anchor when added to the session.

This property is not atomic.

§Safety

This might not be thread-safe.

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