Struct PHASEShape

Source

pub struct PHASEShape { /* private fields */ }

Available on crate feature PHASEShape only.

Expand description

The physical representation of an object within the simulated acoustic scene.

Implementations§

Source §

pub unsafe fn initWithEngine_mesh( this: Allocated<Self>, engine: &PHASEEngine, mesh: &MDLMesh, ) -> Retained<Self>

Available on crate features PHASEEngine and objc2-model-io only.

Initialize a shape from a mesh.

One PHASEShapeElement will be created for every submesh within the mesh.

Note: A single shape can be used to create multiple instances of sources and occluders. For example, a client could create a single shape for a window, then create multiple occluders from it. The same can be done with with sources.

Parameter engine: The engine this shape will be used with.

Parameter mesh: A Model I/O mesh object.

Returns: A new shape object

Source

pub unsafe fn initWithEngine_mesh_materials( this: Allocated<Self>, engine: &PHASEEngine, mesh: &MDLMesh, materials: &NSArray<PHASEMaterial>, ) -> Retained<Self>

Available on crate features PHASEEngine and PHASEMaterial and objc2-model-io only.

Initialize a shape from an MDLMesh and a list of materials

Parameter engine: The engine this shape will be used with

Parameter mesh: A Model I/O mesh object.

Parameter materials: An array of PHASEMaterial objects that overrides any acoustical materials within the mesh object

Returns: A new shape object

The materials array cannot be empty and cannot contain nil entries, otherwise an exception is thrown. If the number of submeshes within the mesh are less than or equal to the size of the material array, the material will be assigned to the corresponding element. If the number of submeshes within the mesh is greater than the size of the material array, the material assigned to the element will be the index of the element modulo the number of materials. IE: given a mesh with 6 submeshes and an array of 3 materials, the element at index 5 will be assigned the material at index: 5 % 3 = 2.

Source

pub unsafe fn elements(&self) -> Retained<NSArray<PHASEShapeElement>>

List of all the shape elements associated with this shape.

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