Struct SCNAction 

pub struct SCNAction { /* private fields */ }

Available on crate feature SCNAction only.

Apple’s documentation

Implementations

impl SCNAction

pub unsafe fn duration(&self) -> NSTimeInterval

This is the expected duration of an action’s animation. The actual time an action takes to complete is modified by the speed property of the action.

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

Setter for duration.

pub unsafe fn timingMode(&self) -> SCNActionTimingMode

Available on crate feature SceneKitTypes only.

The timing mode used to execute an action.

pub unsafe fn setTimingMode(&self, timing_mode: SCNActionTimingMode)

Available on crate feature SceneKitTypes only.

Setter for timingMode.

pub unsafe fn timingFunction(&self) -> SCNActionTimingFunction

Available on crate feature block2 only.

When set, prodives a custom timing via a block. Applies after the ‘timingMode’ property is taken into account, defaults to nil

See: SCNActionTimingFunction

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

Available on crate feature block2 only.

Setter for timingFunction.

Safety

timing_function must be a valid pointer or null.

pub unsafe fn speed(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

A speed factor that modifies how fast an action runs. Defaults to 1.

pub unsafe fn setSpeed(&self, speed: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for speed.

pub unsafe fn reversedAction(&self) -> Retained<SCNAction>

Creates an action that reverses the behavior of another action.

pub unsafe fn moveByX_y_z_duration( delta_x: CGFloat, delta_y: CGFloat, delta_z: CGFloat, duration: NSTimeInterval, ) -> Retained<SCNAction>

Available on crate feature objc2-core-foundation only.

pub unsafe fn moveBy_duration( delta: SCNVector3, duration: NSTimeInterval, ) -> Retained<SCNAction>

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

pub unsafe fn moveTo_duration( location: SCNVector3, duration: NSTimeInterval, ) -> Retained<SCNAction>

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

pub unsafe fn rotateByX_y_z_duration( x_angle: CGFloat, y_angle: CGFloat, z_angle: CGFloat, duration: NSTimeInterval, ) -> Retained<SCNAction>

Available on crate feature objc2-core-foundation only.

pub unsafe fn rotateToX_y_z_duration( x_angle: CGFloat, y_angle: CGFloat, z_angle: CGFloat, duration: NSTimeInterval, ) -> Retained<SCNAction>

Available on crate feature objc2-core-foundation only.

pub unsafe fn rotateToX_y_z_duration_shortestUnitArc( x_angle: CGFloat, y_angle: CGFloat, z_angle: CGFloat, duration: NSTimeInterval, shortest_unit_arc: bool, ) -> Retained<SCNAction>

Available on crate feature objc2-core-foundation only.

pub unsafe fn rotateByAngle_aroundAxis_duration( angle: CGFloat, axis: SCNVector3, duration: NSTimeInterval, ) -> Retained<SCNAction>

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

pub unsafe fn rotateToAxisAngle_duration( axis_angle: SCNVector4, duration: NSTimeInterval, ) -> Retained<SCNAction>

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

pub unsafe fn scaleBy_duration( scale: CGFloat, sec: NSTimeInterval, ) -> Retained<SCNAction>

Available on crate feature objc2-core-foundation only.

pub unsafe fn scaleTo_duration( scale: CGFloat, sec: NSTimeInterval, ) -> Retained<SCNAction>

Available on crate feature objc2-core-foundation only.

pub unsafe fn sequence(actions: &NSArray<SCNAction>) -> Retained<SCNAction>

pub unsafe fn group(actions: &NSArray<SCNAction>) -> Retained<SCNAction>

pub unsafe fn repeatAction_count( action: &SCNAction, count: NSUInteger, ) -> Retained<SCNAction>

pub unsafe fn repeatActionForever(action: &SCNAction) -> Retained<SCNAction>

pub unsafe fn fadeInWithDuration(sec: NSTimeInterval) -> Retained<SCNAction>

pub unsafe fn fadeOutWithDuration(sec: NSTimeInterval) -> Retained<SCNAction>

pub unsafe fn fadeOpacityBy_duration( factor: CGFloat, sec: NSTimeInterval, ) -> Retained<SCNAction>

Available on crate feature objc2-core-foundation only.

pub unsafe fn fadeOpacityTo_duration( opacity: CGFloat, sec: NSTimeInterval, ) -> Retained<SCNAction>

Available on crate feature objc2-core-foundation only.

pub unsafe fn hide() -> Retained<SCNAction>

pub unsafe fn unhide() -> Retained<SCNAction>

pub unsafe fn waitForDuration(sec: NSTimeInterval) -> Retained<SCNAction>

pub unsafe fn waitForDuration_withRange( sec: NSTimeInterval, duration_range: NSTimeInterval, ) -> Retained<SCNAction>

pub unsafe fn removeFromParentNode() -> Retained<SCNAction>

pub unsafe fn runBlock( block: &DynBlock<dyn Fn(NonNull<SCNNode>)>, ) -> Retained<SCNAction>

Available on crate features SCNNode and block2 only.

Safety

block block must be sendable.

pub unsafe fn runBlock_queue( block: &DynBlock<dyn Fn(NonNull<SCNNode>)>, queue: &DispatchQueue, ) -> Retained<SCNAction>

Available on crate features SCNNode and block2 and dispatch2 only.

Safety

• block block must be sendable.
• queue possibly has additional threading requirements.

pub unsafe fn javaScriptActionWithScript_duration( script: &NSString, seconds: NSTimeInterval, ) -> Retained<SCNAction>

pub unsafe fn customActionWithDuration_actionBlock( seconds: NSTimeInterval, block: &DynBlock<dyn Fn(NonNull<SCNNode>, CGFloat)>, ) -> Retained<SCNAction>

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

Safety

block block must be sendable.

pub unsafe fn playAudioSource_waitForCompletion( source: &SCNAudioSource, wait: bool, ) -> Retained<SCNAction>

Available on crate feature SCNAudioSource only.

Creates an action that plays a sound

Parameter source: The audio source to play (see SCNAudioSource.h)

Parameter wait: If YES, then the duration of this action is the same as the length of the audio playback. If NO, the action is considered to have completed immediately.

impl SCNAction

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 SCNAction

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNAction

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNAction> for SCNAction

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNAction

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNAction

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNAction

const NAME: &'static str = "SCNAction"

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

type Super = NSObject

The superclass of this class.

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

type Result = SCNAction

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

impl Debug for SCNAction

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

Formats the value using the given formatter.

impl Deref for SCNAction

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNAction

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 SCNAction

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNAction

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

where Self: Sized + Message,

Safety

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

where Self: Sized + Message,

Safety

impl NSCopying for SCNAction

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 SCNAction

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 SCNAction

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNAction

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 SCNAction

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

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

impl DowncastTarget for SCNAction

impl Eq for SCNAction