Struct CHHapticPattern

Source

pub struct CHHapticPattern { /* private fields */ }

Available on crate feature CHHapticPattern only.

Expand description

A set of one or more haptic events and/or Dynamic parameters/parameter curves.

The passed-in arrays’ contents are not owned by the pattern object. Changes made to those arrays after a CHHapticPattern object is created have no effect on that object.

Implementations§

Source §

impl CHHapticPattern

Source

pub unsafe fn duration(&self) -> NSTimeInterval

Pattern duration is calculated as the start time of the pattern’s last event or parameter, plus that event’s duration if present.

Source

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

Source

pub unsafe fn initWithEvents_parameters_error( this: Allocated<Self>, events: &NSArray<CHHapticEvent>, parameters: &NSArray<CHHapticDynamicParameter>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features CHHapticEvent and CHHapticParameter only.

Initialize a new CHHapticPattern.

Parameter events: An NSArray of CHHapticEvents. Can be empty.

Parameter parameters: An NSArray of CHHapticDynamicParameters. Can be empty.

Source

pub unsafe fn initWithEvents_parameterCurves_error( this: Allocated<Self>, events: &NSArray<CHHapticEvent>, parameter_curves: &NSArray<CHHapticParameterCurve>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features CHHapticEvent and CHHapticParameter only.

Initialize a new CHHapticPattern with parameters modulated by parameter curves.

Parameter events: An NSArray of CHHapticEvents. Can be empty.

Parameter parameterCurves: An NSArray of CHHapticParameterCurves. Can be empty.

Source

pub unsafe fn initWithDictionary_error( this: Allocated<Self>, pattern_dict: &NSDictionary<CHHapticPatternKey, AnyObject>, ) -> Result<Retained<Self>, Retained<NSError>>

Initialize a new CHHapticPattern using the passed-in NSDictionary.

Parameter patternDict: NSDictionary containing a pattern property list.

§Safety

pattern_dict generic should be of the correct type.

Source

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

Initialize a new CHHapticPattern using the contents of the passed-in NSURL.

Parameter ahapURL: NSURL of an ahap file.

This URL must reference a valid AHAP file.

Source

pub unsafe fn exportDictionaryAndReturnError( &self, ) -> Result<Retained<NSDictionary<CHHapticPatternKey, AnyObject>>, Retained<NSError>>

Returns a NSDictionary representation of the contents of the pattern.

Patterns containing custom audio resource IDs cannot be exported and will return nil with the error code set to CHHapticErrorCodeOperationNotPermitted.

Source §

impl CHHapticPattern

Methods declared on superclass NSObject.

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