Struct SCNIKConstraint

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

Available on crate feature SCNConstraint only.

A SCNIKConstraint applies an inverse kinematics constraint

See also Apple’s documentation

Implementations

impl SCNIKConstraint

pub unsafe fn initWithChainRootNode( this: Allocated<Self>, chain_root_node: &SCNNode, ) -> Retained<Self>

Available on crate feature SCNNode only.

Creates and returns a SCNIKConstraint object with the specified parameter.

Parameter chainRootNode: The root node of the kinematic chain.

“chainRootNode” must be an ancestor of the node on which the constraint is applied.

pub unsafe fn inverseKinematicsConstraintWithChainRootNode( chain_root_node: &SCNNode, ) -> Retained<Self>

Available on crate feature SCNNode only.

Creates and returns a SCNIKConstraint object with the specified parameter.

Parameter chainRootNode: The root node of the kinematic chain.

“chainRootNode” must be an ancestor of the node on which the constraint is applied.

pub unsafe fn chainRootNode(&self) -> Retained<SCNNode>

Available on crate feature SCNNode only.

Specifies the root node of the kinematic chain.

pub unsafe fn targetPosition(&self) -> SCNVector3

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

Specifies the target position (in world space coordinates) of the end joint (i.e the node that owns the IK constraint). Defaults to (0,0,0). Animatable.

pub unsafe fn setTargetPosition(&self, target_position: SCNVector3)

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

Setter for targetPosition.

pub unsafe fn setMaxAllowedRotationAngle_forJoint( &self, angle: CGFloat, node: &SCNNode, )

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

Specifies the maximum rotation allowed (in degrees) for the specified joint from its initial orientation. Defaults to 180.

pub unsafe fn maxAllowedRotationAngleForJoint(&self, node: &SCNNode) -> CGFloat

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

impl SCNIKConstraint

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = SCNConstraint>

pub unsafe fn isEnabled(&self) -> bool

Determines whether the constraint is enabled or not. Defaults to YES.

pub unsafe fn setEnabled(&self, enabled: bool)

Setter for isEnabled.

pub unsafe fn influenceFactor(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the inflence factor of the receiver. Defaults to 1. Animatable

pub unsafe fn setInfluenceFactor(&self, influence_factor: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for influenceFactor.

pub unsafe fn isIncremental(&self) -> bool

Specifies whether or not the contraint should applies incrementally and have it’s effect being cumulated over the rendered frames. Defaults to YES starting macOS 10.13, iOS 11, tvOS 11 and watchOS 4. Defaults to NO in previous versions.

pub unsafe fn setIncremental(&self, incremental: bool)

Setter for isIncremental.

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.

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 SCNIKConstraint

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNIKConstraint

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNConstraint> for SCNIKConstraint

fn as_ref(&self) -> &SCNConstraint

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

impl AsRef<SCNIKConstraint> for SCNIKConstraint

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNIKConstraint

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNIKConstraint

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<SCNConstraint> for SCNIKConstraint

fn borrow(&self) -> &SCNConstraint

Immutably borrows from an owned value.

impl ClassType for SCNIKConstraint

const NAME: &'static str = "SCNIKConstraint"

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

type Super = SCNConstraint

The superclass of this class.

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

type Result = SCNIKConstraint

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

impl Debug for SCNIKConstraint

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

Formats the value using the given formatter.

impl Deref for SCNIKConstraint

type Target = SCNConstraint

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNIKConstraint

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 SCNIKConstraint

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNIKConstraint

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for SCNIKConstraint

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 SCNIKConstraint

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 SCNIKConstraint

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNIKConstraint

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 SCNIKConstraint

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

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

impl SCNAnimatable for SCNIKConstraint

Available on crate feature SCNAnimation only.

unsafe fn addAnimation_forKey( &self, animation: &ProtocolObject<dyn SCNAnimationProtocol>, key: Option<&NSString>, )

where Self: Sized + Message,

Adds and runs an animation

unsafe fn addAnimationPlayer_forKey( &self, player: &SCNAnimationPlayer, key: Option<&NSString>, )

where Self: Sized + Message,

Add an animation player.

unsafe fn removeAllAnimations(&self)

where Self: Sized + Message,

Remove all animations.

unsafe fn removeAllAnimationsWithBlendOutDuration(&self, duration: CGFloat)

where Self: Sized + Message,

Available on crate feature objc2-core-foundation only.

Smoothly remove all animations.

unsafe fn removeAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

Remove the animation with the given identifier.

unsafe fn removeAnimationForKey_blendOutDuration( &self, key: &NSString, duration: CGFloat, )

where Self: Sized + Message,

Available on crate feature objc2-core-foundation only.

Smoothly remove the animation with the given identifier.

unsafe fn animationKeys(&self) -> Retained<NSArray<NSString>>

where Self: Sized + Message,

Returns an array containing the keys of all animations currently attached to the receiver.

unsafe fn animationPlayerForKey( &self, key: &NSString, ) -> Option<Retained<SCNAnimationPlayer>>

where Self: Sized + Message,

Returns the animation player with the given identifier

unsafe fn removeAnimationForKey_fadeOutDuration( &self, key: &NSString, duration: CGFloat, )

where Self: Sized + Message,

👎Deprecated

Available on crate feature objc2-core-foundation only.

Smoothly remove the animation with the given identifier.

unsafe fn animationForKey( &self, key: &NSString, ) -> Option<Retained<CAAnimation>>

where Self: Sized + Message,

👎Deprecated

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

Returns the animation with the given identifier

unsafe fn pauseAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setPaused:] instead

Pause the animation with the given identifier.

unsafe fn resumeAnimationForKey(&self, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setPaused:] instead

Resume the animation with the given identifier.

unsafe fn setSpeed_forAnimationKey(&self, speed: CGFloat, key: &NSString)

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer setSpeed:] instead

Available on crate feature objc2-core-foundation only.

Update the animation speed of the animation with the given identifier.

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

where Self: Sized + Message,

👎Deprecated: Use -[SCNAnimationPlayer paused] instead

Returns whether the animation for the specified identifier is paused.

impl DowncastTarget for SCNIKConstraint

impl Eq for SCNIKConstraint