Struct SCNAnimation 

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

Available on crate feature SCNAnimation only.

SCNAnimation represents an animation that targets a specific key path.

See also Apple’s documentation

Implementations

impl SCNAnimation

pub unsafe fn animationWithContentsOfURL( animation_url: &NSURL, ) -> Retained<SCNAnimation>

Loads and returns an animation loaded from the specified URL.

Parameter animationUrl: The url to load.

pub unsafe fn animationNamed( animation_name: &NSString, ) -> Retained<SCNAnimation>

Loads and returns the animation with the specified name in the current application bundle.

Parameter animationName: The name of the animation to load.

pub unsafe fn animationWithCAAnimation( ca_animation: &CAAnimation, ) -> Retained<SCNAnimation>

Available on crate feature objc2-quartz-core and non-watchOS only.

Returns a SCNAnimation initialized from a CAAnimation.

Parameter caAnimation: The CAAnimation to initialize from.

Only CABasicAnimation, CAKeyframeAnimation and CAAnimationGroup are currently supported.

pub unsafe fn duration(&self) -> NSTimeInterval

The duration of the animation in seconds. Defaults to 0.

pub unsafe fn setDuration(&self, duration: NSTimeInterval)

Setter for duration.

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

The key-path describing the property to be animated for single-property animations, nil for animations targetting multiple nodes. defaults to nil. The key-path uses the KVC syntax. It’s also possible to target a specific sub-node with the following syntax: / <node -name>.property1.property2.field (field is optional, <node -name> is the name of the targeted node).

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

Setter for keyPath.

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

A timing function defining the pacing of the animation. Defaults to nil indicating linear pacing.

pub unsafe fn setTimingFunction(&self, timing_function: &SCNTimingFunction)

Setter for timingFunction.

pub unsafe fn blendInDuration(&self) -> NSTimeInterval

Determines the receiver’s blend-in duration.

When the blendInDuration is greater than zero, the effect of the animation progressively increase from 0% to 100% during the specified duration.

pub unsafe fn setBlendInDuration(&self, blend_in_duration: NSTimeInterval)

Setter for blendInDuration.

pub unsafe fn blendOutDuration(&self) -> NSTimeInterval

Determines the receiver’s blend-out duration.

When the blendOutDuration is greater than zero, the effect of the animation progressively decrease from 100% to 0% at the end of the animation duration.

pub unsafe fn setBlendOutDuration(&self, blend_out_duration: NSTimeInterval)

Setter for blendOutDuration.

pub unsafe fn isRemovedOnCompletion(&self) -> bool

When true, the animation is removed from the render tree once its active duration has passed. Defaults to YES.

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

Setter for isRemovedOnCompletion.

pub unsafe fn isAppliedOnCompletion(&self) -> bool

When true, the animation is applied to the model tree once its active duration has passed. Defaults to NO.

pub unsafe fn setAppliedOnCompletion(&self, applied_on_completion: bool)

Setter for isAppliedOnCompletion.

pub unsafe fn repeatCount(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The repeat count of the object. May be fractional. Defaults to 0.

pub unsafe fn setRepeatCount(&self, repeat_count: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for repeatCount.

pub unsafe fn autoreverses(&self) -> bool

When true, the object plays backwards after playing forwards. Defaults to NO.

pub unsafe fn setAutoreverses(&self, autoreverses: bool)

Setter for autoreverses.

pub unsafe fn startDelay(&self) -> NSTimeInterval

The relative delay to start the animation, in relation to its parent animation if applicable. Defaults to 0.

This property is bridged with CoreAnimations’s beginTime. However, for top level animations, startDelay is relative to the current time (unlike CAAnimation’s beginTime that is absolute). So if a CAAnimation has a non-zero beginTime, startDelay is initialized as caAnimation.beginTime - CACurrentMediaTime().

pub unsafe fn setStartDelay(&self, start_delay: NSTimeInterval)

Setter for startDelay.

pub unsafe fn timeOffset(&self) -> NSTimeInterval

Additional offset in active local time. i.e. to convert from parent time tp to active local time t: t = (tp - begin) * speed + offset. Defaults to 0.

pub unsafe fn setTimeOffset(&self, time_offset: NSTimeInterval)

Setter for timeOffset.

pub unsafe fn fillsForward(&self) -> bool

When true, the animation remains active after its active duration and evaluates to its end value. Defaults to NO.

pub unsafe fn setFillsForward(&self, fills_forward: bool)

Setter for fillsForward.

pub unsafe fn fillsBackward(&self) -> bool

When true, the animation is active before its active duration and evaluates to its start value. Defaults to NO.

pub unsafe fn setFillsBackward(&self, fills_backward: bool)

Setter for fillsBackward.

pub unsafe fn usesSceneTimeBase(&self) -> bool

Determines whether the receiver is evaluated using the scene time or the system time. Defaults to NO.

A scene-time based animation is evaluated using the “sceneTime” value of the renderer that renders the scene. The “sceneTime” base is typically used by players or editors that need to preview, edit and being able to change the evaluation time.

See: SCNSceneSourceAnimationImportPolicyKey

pub unsafe fn setUsesSceneTimeBase(&self, uses_scene_time_base: bool)

Setter for usesSceneTimeBase.

pub unsafe fn animationDidStart(&self) -> SCNAnimationDidStartBlock

Available on crate feature block2 only.

Called when the animation starts.

pub unsafe fn setAnimationDidStart( &self, animation_did_start: SCNAnimationDidStartBlock, )

Available on crate feature block2 only.

Setter for animationDidStart.

pub unsafe fn animationDidStop(&self) -> SCNAnimationDidStopBlock

Available on crate feature block2 only.

Called when the animation either completes its active duration or is removed from the object it is attached to (i.e. the layer). The ‘completed’ argument of SCNAnimationDidStopBlock is true if the animation reached the end of its active duration without being removed.

pub unsafe fn setAnimationDidStop( &self, animation_did_stop: SCNAnimationDidStopBlock, )

Available on crate feature block2 only.

Setter for animationDidStop.

pub unsafe fn animationEvents( &self, ) -> Option<Retained<NSArray<SCNAnimationEvent>>>

Specifies the animation events attached to the receiver.

See: SCNAnimationEvent

pub unsafe fn setAnimationEvents( &self, animation_events: Option<&NSArray<SCNAnimationEvent>>, )

Setter for animationEvents.

pub unsafe fn isAdditive(&self) -> bool

When true the value specified by the animation will be “added” to the current presentation value of the property to produce the new presentation value. The addition function is type-dependent, e.g. for affine transforms the two matrices are concatenated. Defaults to NO.

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

Setter for isAdditive.

pub unsafe fn isCumulative(&self) -> bool

The `cumulative’ property affects how repeating animations produce their result. If true then the current value of the animation is the value at the end of the previous repeat cycle, plus the value of the current repeat cycle. If false, the value is simply the value calculated for the current repeat cycle. Defaults to NO.

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

Setter for isCumulative.

impl SCNAnimation

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 SCNAnimation

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNAnimation

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNAnimation> for SCNAnimation

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNAnimation

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNAnimation

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNAnimation

const NAME: &'static str = "SCNAnimation"

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

type Super = NSObject

The superclass of this class.

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

type Result = SCNAnimation

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

impl Debug for SCNAnimation

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

Formats the value using the given formatter.

impl Deref for SCNAnimation

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNAnimation

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 SCNAnimation

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNAnimation

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

impl NSCopying for SCNAnimation

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 SCNAnimation

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 SCNAnimation

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNAnimation

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 SCNAnimation

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

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

impl DowncastTarget for SCNAnimation

impl Eq for SCNAnimation

impl SCNAnimationProtocol for SCNAnimation