Struct PHASEBlendNodeDefinition

Source

pub struct PHASEBlendNodeDefinition { /* private fields */ }

Available on crate features PHASEDefinition and PHASESoundEventNodes only.

Expand description

An object for defining a blend sound event node when building a sound event.

A blend node blends between its children based on a numeric parameter.

Implementations§

Source §

pub unsafe fn initWithBlendMetaParameterDefinition_identifier( this: Allocated<Self>, blend_meta_parameter_definition: &PHASENumberMetaParameterDefinition, identifier: &NSString, ) -> Retained<Self>

Available on crate feature PHASEMetaParameter only.

Create a blend node definition

Parameter blendMetaParameterDefinition: A metaparameter definition that wil be used to control the parameter of the blend node at runtime.

Parameter identifier: An optional custom identifier to give to this object

Returns: A new PHASEBlendNodeDefinition object

Source

pub unsafe fn initWithBlendMetaParameterDefinition( this: Allocated<Self>, blend_meta_parameter_definition: &PHASENumberMetaParameterDefinition, ) -> Retained<Self>

Available on crate feature PHASEMetaParameter only.

Create a blend node definition

Parameter blendMetaParameterDefinition: A metaparameter definition that wil be used to control the parameter of the blend node at runtime.

Returns: A new PHASEBlendNodeDefinition object

Source

pub unsafe fn initDistanceBlendWithSpatialMixerDefinition_identifier( this: Allocated<Self>, spatial_mixer_definition: &PHASESpatialMixerDefinition, identifier: &NSString, ) -> Retained<Self>

Available on crate feature PHASEMixer only.

Create a blend node definition

Parameter spatialMixerDefinition: A PHASESpatialMixerDefinition that will bind the blend parameter to the distance between the source and listener.

Parameter identifier: An optional custom identifier to give to this object

Returns: A new PHASEBlendNodeDefinition object

Source

pub unsafe fn initDistanceBlendWithSpatialMixerDefinition( this: Allocated<Self>, spatial_mixer_definition: &PHASESpatialMixerDefinition, ) -> Retained<Self>

Available on crate feature PHASEMixer only.

Create a blend node definition

Parameter spatialMixerDefinition: A PHASESpatialMixerDefinition that will bind the blend parameter to the distance between the source and listener.

Returns: A new PHASEBlendNodeDefinition object

Source

pub unsafe fn blendParameterDefinition( &self, ) -> Option<Retained<PHASENumberMetaParameterDefinition>>

Available on crate feature PHASEMetaParameter only.

The readonly property that returns the PHASENumberMetaParameterDefinition this blend node was created with and assigned to.

Source

pub unsafe fn spatialMixerDefinitionForDistance( &self, ) -> Option<Retained<PHASESpatialMixerDefinition>>

Available on crate feature PHASEMixer only.

The readonly property that returns the PHASESpatialMixerDefinition this blend node was created with and assigned to.

Source

pub unsafe fn addRangeForInputValuesBelow_fullGainAtValue_fadeCurveType_subtree( &self, value: c_double, full_gain_at_value: c_double, fade_curve_type: PHASECurveType, subtree: &PHASESoundEventNodeDefinition, )

Available on crate feature PHASETypes only.

Create a blend range that is active for all values below a given threshold.

Parameter value: The value for which the range will be active if the blend node’s input value is below this threshold.

Parameter fullGainAtValue: This value defines a threshold for which a fade curve will be applied to the gain, when the input value is between “value” and “fullGainAtValue”.

Parameter fadeCurveType: A curve type that defines which kind of fade curve to apply.

Parameter subtree: A PHASESoundEventNodeDefinition subtree that will be active for this range.

Source

pub unsafe fn addRangeForInputValuesBetween_highValue_fullGainAtLowValue_fullGainAtHighValue_lowFadeCurveType_highFadeCurveType_subtree( &self, low_value: c_double, high_value: c_double, full_gain_at_low_value: c_double, full_gain_at_high_value: c_double, low_fade_curve_type: PHASECurveType, high_fade_curve_type: PHASECurveType, subtree: &PHASESoundEventNodeDefinition, )

Available on crate feature PHASETypes only.

Create a blend range that is active for all input values between lowValue and highValue

Parameter lowValue: The lower bound for which this range is active.

Parameter highValue: The upper bound for which this range is active.

Parameter fullGainAtLowValue: The threshold for which a fade curve defined by lowFadeCurveType will be applied to the gain when the input value is between lowValue and fullGainAtLowValue

Parameter fullGainAtHighValue: The threshold for which a fade curve defined by highFadeCurveType will be applied to the gain when the input value is between highValue and fullGainAtHighValue

Parameter lowFadeCurveType: A curve type that defines which kind of fade curve to apply for the low fade range.

Parameter highFadeCurveType: A curve type that defines which kind of fade curve to apply for the high fade range..

Parameter subtree: A PHASESoundEventNodeDefinition subtree that will be active for this range.

Source

pub unsafe fn addRangeForInputValuesAbove_fullGainAtValue_fadeCurveType_subtree( &self, value: c_double, full_gain_at_value: c_double, fade_curve_type: PHASECurveType, subtree: &PHASESoundEventNodeDefinition, )

Available on crate feature PHASETypes only.

Create a blend range that is active for all values above a given threshold.

Parameter value: The value for which the range will be active if the blend node’s input value is above this threshold.

Parameter fullGainAtValue: This value defines a threshold for which a fade curve will be applied to the gain, when the input value is between “value” and “fullGainAtValue”.

Parameter fadeCurveType: A curve type that defines which kind of fade curve to apply.

Parameter subtree: A PHASESoundEventNodeDefinition subtree that will be active for this range.

Source

pub unsafe fn addRangeWithEnvelope_subtree( &self, envelope: &PHASEEnvelope, subtree: &PHASESoundEventNodeDefinition, )

Available on crate feature PHASEEnvelope only.

Create a blend range defined by a PHASEEnvelope object.

Parameter envelope: The PHASEEnvelope object that defines the output gain for a range.

Parameter subtree: A PHASESoundEventNodeDefinition subtree that will be active for this range.

Methods from Deref<Target = PHASESoundEventNodeDefinition>§

Source

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

The children of this node definition.

Methods from Deref<Target = PHASEDefinition>§

Source

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

The identifier that uniquely represents this definition.

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