Struct PHASESource

Source

pub struct PHASESource { /* private fields */ }

Available on crate features PHASEObject and PHASESource only.

Expand description

A PHASESource represents where sound originates within the simulated acoustic scene.

PHASE supports both point sources and volumetric sources. A point source simulates the sound from a point in space. A volumetric source simulates the sound from a shape.

Implementations§

Source §

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

Available on crate feature PHASEEngine only.

Initialize a new point source.

Source

pub unsafe fn initWithEngine_shapes( this: Allocated<Self>, engine: &PHASEEngine, shapes: &NSArray<PHASEShape>, ) -> Retained<Self>

Available on crate features PHASEEngine and PHASEShape only.

Initialize a new volumetric source with shapes.

Parameter shapes: The shape(s) of the source within the world

The shapes array cannot be empty, otherwise an exception is thrown.

Note: This function is thread-safe. Clients can safely run this function to create multiple sources from multiple threads, if required.

Source

pub unsafe fn gain(&self) -> c_double

Linear gain scalar.

Note: Values are clamped to the range [0, 1]. Default value is 1.

Source

pub unsafe fn setGain(&self, gain: c_double)

Setter for gain.

Source

pub unsafe fn shapes(&self) -> Retained<NSArray<PHASEShape>>

Available on crate feature PHASEShape only.

Array of shapes associated with this source.

Methods from Deref<Target = PHASEObject>§

Source

pub unsafe fn addChild_error( &self, child: &PHASEObject, ) -> Result<(), Retained<NSError>>

Add a child to this object

Parameter child: The child object

Parameter error: Returns an error if the child already has a parent.

Returns: YES for success

Source

pub unsafe fn removeChild(&self, child: &PHASEObject)

Remove a child from this object.

Source

pub unsafe fn removeChildren(&self)

Remove all the children from this object

Source

pub unsafe fn parent(&self) -> Option<Retained<PHASEObject>>

The parent of this object, or nil if this object doesn’t have a parent object.

Source

pub unsafe fn children(&self) -> Retained<NSArray<PHASEObject>>

The children of this object.

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