Struct CABasicAnimation 

pub struct CABasicAnimation { /* private fields */ }

Available on crate feature CAAnimation only.

Subclass for basic (single-keyframe) animations. *

See also Apple’s documentation

Implementations

impl CABasicAnimation

pub fn fromValue(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setFromValue(&self, from_value: Option<&AnyObject>)

Setter for fromValue.

Safety

from_value should be of the correct type.

pub fn toValue(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setToValue(&self, to_value: Option<&AnyObject>)

Setter for toValue.

Safety

to_value should be of the correct type.

pub fn byValue(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setByValue(&self, by_value: Option<&AnyObject>)

Setter for byValue.

Safety

by_value should be of the correct type.

impl CABasicAnimation

Methods declared on superclass CAPropertyAnimation.

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

impl CABasicAnimation

Methods declared on superclass CAAnimation.

pub fn animation() -> Retained<Self>

impl CABasicAnimation

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

Methods from Deref<Target = CAPropertyAnimation>

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

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

Setter for keyPath.

This is copied when set.

pub fn isAdditive(&self) -> bool

pub fn setAdditive(&self, additive: bool)

Setter for isAdditive.

pub fn isCumulative(&self) -> bool

pub fn setCumulative(&self, cumulative: bool)

Setter for isCumulative.

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

Available on crate feature CAValueFunction only.

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

Available on crate feature CAValueFunction only.

Setter for valueFunction.

Methods from Deref<Target = CAAnimation>

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

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

Available on crate feature CAMediaTimingFunction only.

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

Available on crate feature CAMediaTimingFunction only.

Setter for timingFunction.

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

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

Setter for delegate.

pub fn isRemovedOnCompletion(&self) -> bool

pub fn setRemovedOnCompletion(&self, removed_on_completion: bool)

Setter for isRemovedOnCompletion.

pub fn preferredFrameRateRange(&self) -> CAFrameRateRange

Available on crate feature CAFrameRateRange only.

pub 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 CABasicAnimation

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CAAnimation> for CABasicAnimation

fn as_ref(&self) -> &CAAnimation

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

impl AsRef<CABasicAnimation> for CABasicAnimation

fn as_ref(&self) -> &Self

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

impl AsRef<CABasicAnimation> for CASpringAnimation

fn as_ref(&self) -> &CABasicAnimation

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

impl AsRef<CAPropertyAnimation> for CABasicAnimation

fn as_ref(&self) -> &CAPropertyAnimation

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

impl AsRef<NSObject> for CABasicAnimation

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for CABasicAnimation

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CAAnimation> for CABasicAnimation

fn borrow(&self) -> &CAAnimation

Immutably borrows from an owned value.

impl Borrow<CABasicAnimation> for CASpringAnimation

fn borrow(&self) -> &CABasicAnimation

Immutably borrows from an owned value.

impl Borrow<CAPropertyAnimation> for CABasicAnimation

fn borrow(&self) -> &CAPropertyAnimation

Immutably borrows from an owned value.

impl Borrow<NSObject> for CABasicAnimation

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl CAAction for CABasicAnimation

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

where Self: Sized + Message,

Available on crate feature CALayer only.

Safety

impl CAMediaTiming for CABasicAnimation

fn beginTime(&self) -> CFTimeInterval

where Self: Sized + Message,

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

fn setBeginTime(&self, begin_time: CFTimeInterval)

where Self: Sized + Message,

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

Setter for beginTime.

fn duration(&self) -> CFTimeInterval

where Self: Sized + Message,

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

fn setDuration(&self, duration: CFTimeInterval)

where Self: Sized + Message,

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

Setter for duration.

fn speed(&self) -> c_float

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

fn setSpeed(&self, speed: c_float)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for speed.

fn timeOffset(&self) -> CFTimeInterval

where Self: Sized + Message,

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

fn setTimeOffset(&self, time_offset: CFTimeInterval)

where Self: Sized + Message,

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

Setter for timeOffset.

fn repeatCount(&self) -> c_float

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

fn setRepeatCount(&self, repeat_count: c_float)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for repeatCount.

fn repeatDuration(&self) -> CFTimeInterval

where Self: Sized + Message,

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

fn setRepeatDuration(&self, repeat_duration: CFTimeInterval)

where Self: Sized + Message,

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

Setter for repeatDuration.

fn autoreverses(&self) -> bool

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

fn setAutoreverses(&self, autoreverses: bool)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for autoreverses.

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

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

fn setFillMode(&self, fill_mode: &CAMediaTimingFillMode)

where Self: Sized + Message,

Available on crate feature CAMediaTiming only.

Setter for fillMode.

impl ClassType for CABasicAnimation

const NAME: &'static str = "CABasicAnimation"

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

type Super = CAPropertyAnimation

The superclass of this class.

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

type Result = CABasicAnimation

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

impl Debug for CABasicAnimation

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

Formats the value using the given formatter.

impl DefaultRetained for CABasicAnimation

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for CABasicAnimation

type Target = CAPropertyAnimation

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CABasicAnimation

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 CABasicAnimation

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for CABasicAnimation

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 CABasicAnimation

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 CABasicAnimation

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for CABasicAnimation

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 CABasicAnimation

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

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

impl DowncastTarget for CABasicAnimation

impl Eq for CABasicAnimation

impl NSCoding for CABasicAnimation