Struct PKStrokePath 

pub struct PKStrokePath { /* private fields */ }

Available on crate feature PKStrokePath only.

A uniform cubic B-spline representing the point data of a PKStroke.

See also Apple’s documentation

Implementations

impl PKStrokePath

pub unsafe fn initWithControlPoints_creationDate( this: Allocated<Self>, control_points: &NSArray<PKStrokePoint>, creation_date: &NSDate, ) -> Retained<Self>

Available on crate feature PKStrokePoint only.

Create a stroke path value with the given cubic B-spline control points.

Parameter controlPoints: An array of control points for a cubic B-spline.

Parameter creationDate: The start time of this path.

pub unsafe fn count(&self) -> NSUInteger

The number of control points in this stroke path.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn creationDate(&self) -> Retained<NSDate>

The time at which this stroke path was started. The timeOffset of contained PKStrokePoints is relative to this date.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn pointAtIndex(&self, i: NSUInteger) -> Retained<PKStrokePoint>

Available on crate feature PKStrokePoint only.

Returns B-spline control point at index i.

pub unsafe fn objectAtIndexedSubscript( &self, i: NSUInteger, ) -> Retained<PKStrokePoint>

Available on crate feature PKStrokePoint only.

Returns B-spline control point at index i.

pub unsafe fn interpolatedLocationAt( &self, parametric_value: CGFloat, ) -> CGPoint

Available on crate feature objc2-core-foundation only.

The on-curve location for the floating point [0, count-1] parametricValue parameter.

This has better performance than [self interpolatedPointAt: parametricValue].location for when only the location is required.

pub unsafe fn interpolatedPointAt( &self, parametric_value: CGFloat, ) -> Retained<PKStrokePoint>

Available on crate features PKStrokePoint and objc2-core-foundation only.

The on-curve point for the floating point [0, count-1] parametricValue parameter.

pub unsafe fn enumerateInterpolatedPointsInRange_strideByDistance_usingBlock( &self, range: &PKFloatRange, distance_step: CGFloat, block: &DynBlock<dyn Fn(NonNull<PKStrokePoint>, NonNull<Bool>)>, )

Available on crate features PKFloatRange and PKStrokePoint and block2 and objc2-core-foundation only.

Executes a given block using each point in a range with a distance step.

Parameter range: The parametric range to enumerate points in.

Parameter distanceStep: The distance to step between points.

Parameter block: The block to execute for each point. This block takes two parameters point The interpolated point on the spline. stop A reference to a Boolean value. Setting the value to YES within the block stops further enumeration of the array. If a block stops further enumeration, that block continues to run until it’s finished.

pub unsafe fn enumerateInterpolatedPointsInRange_strideByTime_usingBlock( &self, range: &PKFloatRange, time_step: NSTimeInterval, block: &DynBlock<dyn Fn(NonNull<PKStrokePoint>, NonNull<Bool>)>, )

Available on crate features PKFloatRange and PKStrokePoint and block2 only.

Executes a given block using each point in a range with a time step.

Parameter range: The parametric range to enumerate points in.

Parameter timeStep: The time interval to step between points.

Parameter block: The block to execute for each point. This block takes two parameters point The interpolated point on the spline. stop A reference to a Boolean value. Setting the value to YES within the block stops further enumeration of the array. If a block stops further enumeration, that block continues to run until it’s finished.

pub unsafe fn enumerateInterpolatedPointsInRange_strideByParametricStep_usingBlock( &self, range: &PKFloatRange, parametric_step: CGFloat, block: &DynBlock<dyn Fn(NonNull<PKStrokePoint>, NonNull<Bool>)>, )

Available on crate features PKFloatRange and PKStrokePoint and block2 and objc2-core-foundation only.

Executes a given block using each point in a range with a parametric step.

Parameter range: The parametric range to enumerate points in.

Parameter parametricStep: The parametric step between points.

Parameter block: The block to execute for each point. This block takes two parameters point The interpolated point on the spline. stop A reference to a Boolean value. Setting the value to YES within the block stops further enumeration of the array. If a block stops further enumeration, that block continues to run until it’s finished.

pub unsafe fn parametricValue_offsetByDistance( &self, parametric_value: CGFloat, distance_step: CGFloat, ) -> CGFloat

Available on crate feature objc2-core-foundation only.

Returns a parametric value on the B-spline that is a specified distance from the given parametric value.

Parameter parametricValue: The floating point [0, count-1] parametric value.

Parameter distanceStep: The distance to offset parametricValue. distanceStep can be positive or negative.

Returns: A parametric value offset by distanceStep from parametricValue.

pub unsafe fn parametricValue_offsetByTime( &self, parametric_value: CGFloat, time_step: NSTimeInterval, ) -> CGFloat

Available on crate feature objc2-core-foundation only.

Returns a parametric value on the B-spline that is a specified time from the given parametric value.

Parameter parametricValue: The floating point [0, count-1] parametric value.

Parameter timeStep: The time to offset parametricValue. timeStep can be positive or negative.

Returns: A parametric value offset by timeStep from parametricValue.

impl PKStrokePath

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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());

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.

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

Trait Implementations

impl AsRef<AnyObject> for PKStrokePath

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for PKStrokePath

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PKStrokePath> for PKStrokePath

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for PKStrokePath

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for PKStrokePath

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for PKStrokePath

const NAME: &'static str = "PKStrokePath"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<PKStrokePath as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for PKStrokePath

type Result = PKStrokePath

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for PKStrokePath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for PKStrokePath

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for PKStrokePath

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for PKStrokePath

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for PKStrokePath

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for PKStrokePath

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for PKStrokePath

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for PKStrokePath

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for PKStrokePath

impl Eq for PKStrokePath

impl Send for PKStrokePath

impl Sync for PKStrokePath