Struct ARReferenceObject

Source

pub struct ARReferenceObject { /* private fields */ }

Available on crate features ARReferenceObject and objc2 only.

Expand description

A reference object to track in the scene.

Implementations§

Source §

impl ARReferenceObject

Source

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

Available on crate feature objc2-foundation only.

An optional name used to identify the object.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn setName(&self, name: Option<&NSString>)

Available on crate feature objc2-foundation only.

Setter for name.

This is copied when set.

§Safety

This might not be thread-safe.

Source

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

Available on crate feature objc2-foundation only.

The AR resource group name for this object.

If this object was loaded via an AR resource group in the Xcode asset catalogue this property will have the name of the resource group, else be set to nil.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn rawFeaturePoints(&self) -> Retained<ARPointCloud>

Available on crate feature ARPointCloud only.

The feature points of the object.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn referenceObjectsInGroupNamed_bundle( name: &NSString, bundle: Option<&NSBundle>, ) -> Option<Retained<NSSet<ARReferenceObject>>>

Available on crate feature objc2-foundation only.

Returns the set of ARReferenceObjects in the specified resource group and bundle.

Parameter name: The name of the resource group.

Parameter bundle: The bundle containing the image file or asset catalog. Specify nil to search the app’s main bundle.

Returns: The set of reference objects or nil on error.

Source

pub unsafe fn initWithArchiveURL_error( this: Allocated<Self>, url: &NSURL, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate feature objc2-foundation only.

Initializes a new reference object with the contents of an archive at the specified URL.

Parameter url: The URL from which to read data (.arobject archive).

Parameter error: The error to populate if the object could not be initialized.

Source

pub unsafe fn exportObjectToURL_previewImage_error( &self, url: &NSURL, preview_image: Option<&UIImage>, ) -> Result<(), Retained<NSError>>

Available on crate features objc2-foundation and objc2-ui-kit only.

Exports the object as an archive at the given URL.

The URL path should use ARReferenceObjectArchiveExtension (.arobject) for the file extension. If serialization across devices is desired, NSKeyedArchiver should be used instead.

Parameter url: The URL at which to write the exported object.

Parameter previewImage: An optional preview image to include in the archive.

Parameter error: The error to populate if the write is not successful.

Returns: YES if the location is written successfully, otherwise NO.

Source

pub unsafe fn referenceObjectByMergingObject_error( &self, object: &ARReferenceObject, ) -> Result<Retained<ARReferenceObject>, Retained<NSError>>

Available on crate feature objc2-foundation only.

Returns a new reference object by aligning and merging the provided object with this reference.

This can be used to combine multiple scans of the same object for detection in different conditions. The object being merged must share similar feature points for the merge to succeed.

Parameter object: The reference object to align and merge.

Parameter error: The error to populate if the merge is not successful.

Returns: A new reference object combining features of both scans or nil if the merge was not successful.

Source

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

Unavailable

Source

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

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