Struct CAKeyframeAnimation

#[repr(C)]
pub struct CAKeyframeAnimation { /* private fields */ }

Available on crate feature CAAnimation only.

General keyframe animation class. *

See also Apple’s documentation

Implementations

impl CAKeyframeAnimation

pub unsafe fn values(&self) -> Option<Retained<NSArray>>

pub unsafe fn setValues(&self, values: Option<&NSArray>)

Setter for values.

pub unsafe fn path(&self) -> Option<Retained<CGPath>>

Available on crate feature objc2-core-graphics only.

pub unsafe fn setPath(&self, path: Option<&CGPath>)

Available on crate feature objc2-core-graphics only.

Setter for path.

pub unsafe fn keyTimes(&self) -> Option<Retained<NSArray<NSNumber>>>

pub unsafe fn setKeyTimes(&self, key_times: Option<&NSArray<NSNumber>>)

Setter for keyTimes.

pub unsafe fn timingFunctions( &self, ) -> Option<Retained<NSArray<CAMediaTimingFunction>>>

Available on crate feature CAMediaTimingFunction only.

pub unsafe fn setTimingFunctions( &self, timing_functions: Option<&NSArray<CAMediaTimingFunction>>, )

Available on crate feature CAMediaTimingFunction only.

Setter for timingFunctions.

pub unsafe fn calculationMode(&self) -> Retained<CAAnimationCalculationMode>

pub unsafe fn setCalculationMode( &self, calculation_mode: &CAAnimationCalculationMode, )

Setter for calculationMode.

pub unsafe fn tensionValues(&self) -> Option<Retained<NSArray<NSNumber>>>

pub unsafe fn setTensionValues( &self, tension_values: Option<&NSArray<NSNumber>>, )

Setter for tensionValues.

pub unsafe fn continuityValues(&self) -> Option<Retained<NSArray<NSNumber>>>

pub unsafe fn setContinuityValues( &self, continuity_values: Option<&NSArray<NSNumber>>, )

Setter for continuityValues.

pub unsafe fn biasValues(&self) -> Option<Retained<NSArray<NSNumber>>>

pub unsafe fn setBiasValues(&self, bias_values: Option<&NSArray<NSNumber>>)

Setter for biasValues.

pub unsafe fn rotationMode(&self) -> Option<Retained<CAAnimationRotationMode>>

pub unsafe fn setRotationMode( &self, rotation_mode: Option<&CAAnimationRotationMode>, )

Setter for rotationMode.

impl CAKeyframeAnimation

Methods declared on superclass CAPropertyAnimation.

pub unsafe fn animationWithKeyPath(path: Option<&NSString>) -> Retained<Self>

impl CAKeyframeAnimation

Methods declared on superclass CAAnimation.

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

impl CAKeyframeAnimation

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = CAPropertyAnimation>

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

pub unsafe fn setKeyPath(&self, key_path: Option<&NSString>)

Setter for keyPath.

pub unsafe fn isAdditive(&self) -> bool

pub unsafe fn setAdditive(&self, additive: bool)

Setter for isAdditive.

pub unsafe fn isCumulative(&self) -> bool

pub unsafe fn setCumulative(&self, cumulative: bool)

Setter for isCumulative.

pub unsafe fn valueFunction(&self) -> Option<Retained<CAValueFunction>>

Available on crate feature CAValueFunction only.

pub unsafe fn setValueFunction(&self, value_function: Option<&CAValueFunction>)

Available on crate feature CAValueFunction only.

Setter for valueFunction.

Methods from Deref<Target = CAAnimation>

pub unsafe fn shouldArchiveValueForKey(&self, key: &NSString) -> bool

pub unsafe fn timingFunction(&self) -> Option<Retained<CAMediaTimingFunction>>

Available on crate feature CAMediaTimingFunction only.

pub unsafe fn setTimingFunction( &self, timing_function: Option<&CAMediaTimingFunction>, )

Available on crate feature CAMediaTimingFunction only.

Setter for timingFunction.

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn CAAnimationDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn CAAnimationDelegate>>, )

Setter for delegate.

pub unsafe fn isRemovedOnCompletion(&self) -> bool

pub unsafe fn setRemovedOnCompletion(&self, removed_on_completion: bool)

Setter for isRemovedOnCompletion.

pub unsafe fn preferredFrameRateRange(&self) -> CAFrameRateRange

Available on crate feature CAFrameRateRange only.

pub unsafe fn setPreferredFrameRateRange( &self, preferred_frame_rate_range: CAFrameRateRange, )

Available on crate feature CAFrameRateRange only.

Setter for preferredFrameRateRange.

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 CAKeyframeAnimation

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CAAnimation> for CAKeyframeAnimation

fn as_ref(&self) -> &CAAnimation

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

impl AsRef<CAKeyframeAnimation> for CAKeyframeAnimation

fn as_ref(&self) -> &Self

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

impl AsRef<CAPropertyAnimation> for CAKeyframeAnimation

fn as_ref(&self) -> &CAPropertyAnimation

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

impl AsRef<NSObject> for CAKeyframeAnimation

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CAKeyframeAnimation

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CAAnimation> for CAKeyframeAnimation

fn borrow(&self) -> &CAAnimation

Immutably borrows from an owned value.

impl Borrow<CAPropertyAnimation> for CAKeyframeAnimation

fn borrow(&self) -> &CAPropertyAnimation

Immutably borrows from an owned value.

impl Borrow<NSObject> for CAKeyframeAnimation

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl CAAction for CAKeyframeAnimation

unsafe fn runActionForKey_object_arguments( &self, event: &NSString, an_object: &AnyObject, dict: Option<&NSDictionary>, )

where Self: Sized + Message,

Available on crate feature CALayer only.

impl CAMediaTiming for CAKeyframeAnimation

unsafe fn beginTime(&self) -> CFTimeInterval

where Self: Sized + Message,

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

unsafe fn setBeginTime(&self, begin_time: CFTimeInterval)

where Self: Sized + Message,

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

Setter for beginTime.

unsafe fn duration(&self) -> CFTimeInterval

where Self: Sized + Message,

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

unsafe fn setDuration(&self, duration: CFTimeInterval)

where Self: Sized + Message,

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

Setter for duration.

unsafe fn speed(&self) -> c_float

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

unsafe fn setSpeed(&self, speed: c_float)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for speed.

unsafe fn timeOffset(&self) -> CFTimeInterval

where Self: Sized + Message,

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

unsafe fn setTimeOffset(&self, time_offset: CFTimeInterval)

where Self: Sized + Message,

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

Setter for timeOffset.

unsafe fn repeatCount(&self) -> c_float

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

unsafe fn setRepeatCount(&self, repeat_count: c_float)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for repeatCount.

unsafe fn repeatDuration(&self) -> CFTimeInterval

where Self: Sized + Message,

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

unsafe fn setRepeatDuration(&self, repeat_duration: CFTimeInterval)

where Self: Sized + Message,

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

Setter for repeatDuration.

unsafe fn autoreverses(&self) -> bool

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

unsafe fn setAutoreverses(&self, autoreverses: bool)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for autoreverses.

unsafe fn fillMode(&self) -> Retained<CAMediaTimingFillMode>

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

unsafe fn setFillMode(&self, fill_mode: &CAMediaTimingFillMode)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for fillMode.

impl ClassType for CAKeyframeAnimation

const NAME: &'static str = "CAKeyframeAnimation"

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

type Super = CAPropertyAnimation

The superclass of this class.

type ThreadKind = <<CAKeyframeAnimation 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 CAKeyframeAnimation

type Result = CAKeyframeAnimation

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

impl Debug for CAKeyframeAnimation

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

Formats the value using the given formatter.

impl Deref for CAKeyframeAnimation

type Target = CAPropertyAnimation

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CAKeyframeAnimation

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 CAKeyframeAnimation

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for CAKeyframeAnimation

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 CAKeyframeAnimation

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 NSSecureCoding for CAKeyframeAnimation

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CAKeyframeAnimation

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 CAKeyframeAnimation

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

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

impl DowncastTarget for CAKeyframeAnimation

impl Eq for CAKeyframeAnimation

impl NSCoding for CAKeyframeAnimation