Struct SCNPhysicsBody

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

Available on crate feature SCNPhysicsBody only.

The SCNPhysicsBody class describes the physics properties (such as mass, friction…) of a node.

See also Apple’s documentation

Implementations

impl SCNPhysicsBody

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

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

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

pub unsafe fn bodyWithType_shape( type: SCNPhysicsBodyType, shape: Option<&SCNPhysicsShape>, ) -> Retained<Self>

Available on crate feature SCNPhysicsShape only.

pub unsafe fn type(&self) -> SCNPhysicsBodyType

pub unsafe fn setType(&self, type: SCNPhysicsBodyType)

Setter for type.

pub unsafe fn mass(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setMass(&self, mass: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for mass.

pub unsafe fn momentOfInertia(&self) -> SCNVector3

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

pub unsafe fn setMomentOfInertia(&self, moment_of_inertia: SCNVector3)

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

Setter for momentOfInertia.

pub unsafe fn usesDefaultMomentOfInertia(&self) -> bool

pub unsafe fn setUsesDefaultMomentOfInertia( &self, uses_default_moment_of_inertia: bool, )

Setter for usesDefaultMomentOfInertia.

pub unsafe fn charge(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setCharge(&self, charge: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for charge.

pub unsafe fn friction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setFriction(&self, friction: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for friction.

pub unsafe fn restitution(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setRestitution(&self, restitution: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for restitution.

pub unsafe fn rollingFriction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setRollingFriction(&self, rolling_friction: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for rollingFriction.

pub unsafe fn physicsShape(&self) -> Option<Retained<SCNPhysicsShape>>

Available on crate feature SCNPhysicsShape only.

pub unsafe fn setPhysicsShape(&self, physics_shape: Option<&SCNPhysicsShape>)

Available on crate feature SCNPhysicsShape only.

Setter for physicsShape.

pub unsafe fn isResting(&self) -> bool

pub unsafe fn allowsResting(&self) -> bool

pub unsafe fn setAllowsResting(&self, allows_resting: bool)

Setter for allowsResting.

pub unsafe fn velocity(&self) -> SCNVector3

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

pub unsafe fn setVelocity(&self, velocity: SCNVector3)

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

Setter for velocity.

pub unsafe fn angularVelocity(&self) -> SCNVector4

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

pub unsafe fn setAngularVelocity(&self, angular_velocity: SCNVector4)

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

Setter for angularVelocity.

pub unsafe fn damping(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setDamping(&self, damping: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for damping.

pub unsafe fn angularDamping(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setAngularDamping(&self, angular_damping: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for angularDamping.

pub unsafe fn velocityFactor(&self) -> SCNVector3

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

pub unsafe fn setVelocityFactor(&self, velocity_factor: SCNVector3)

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

Setter for velocityFactor.

pub unsafe fn angularVelocityFactor(&self) -> SCNVector3

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

pub unsafe fn setAngularVelocityFactor( &self, angular_velocity_factor: SCNVector3, )

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

Setter for angularVelocityFactor.

pub unsafe fn categoryBitMask(&self) -> NSUInteger

pub unsafe fn setCategoryBitMask(&self, category_bit_mask: NSUInteger)

Setter for categoryBitMask.

pub unsafe fn collisionBitMask(&self) -> NSUInteger

pub unsafe fn setCollisionBitMask(&self, collision_bit_mask: NSUInteger)

Setter for collisionBitMask.

pub unsafe fn contactTestBitMask(&self) -> NSUInteger

pub unsafe fn setContactTestBitMask(&self, contact_test_bit_mask: NSUInteger)

Setter for contactTestBitMask.

pub unsafe fn isAffectedByGravity(&self) -> bool

pub unsafe fn setAffectedByGravity(&self, affected_by_gravity: bool)

Setter for isAffectedByGravity.

pub unsafe fn applyForce_impulse(&self, direction: SCNVector3, impulse: bool)

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

pub unsafe fn applyForce_atPosition_impulse( &self, direction: SCNVector3, position: SCNVector3, impulse: bool, )

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

pub unsafe fn applyTorque_impulse(&self, torque: SCNVector4, impulse: bool)

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

pub unsafe fn clearAllForces(&self)

pub unsafe fn resetTransform(&self)

pub unsafe fn setResting(&self, resting: bool)

pub unsafe fn continuousCollisionDetectionThreshold(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setContinuousCollisionDetectionThreshold( &self, continuous_collision_detection_threshold: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for continuousCollisionDetectionThreshold.

pub unsafe fn centerOfMassOffset(&self) -> SCNVector3

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

pub unsafe fn setCenterOfMassOffset(&self, center_of_mass_offset: SCNVector3)

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

Setter for centerOfMassOffset.

pub unsafe fn linearRestingThreshold(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setLinearRestingThreshold( &self, linear_resting_threshold: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for linearRestingThreshold.

pub unsafe fn angularRestingThreshold(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setAngularRestingThreshold( &self, angular_resting_threshold: CGFloat, )

Available on crate feature objc2-core-foundation only.

Setter for angularRestingThreshold.

impl SCNPhysicsBody

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.

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 SCNPhysicsBody

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNPhysicsBody

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNPhysicsBody> for SCNPhysicsBody

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNPhysicsBody

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNPhysicsBody

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNPhysicsBody

const NAME: &'static str = "SCNPhysicsBody"

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

type Super = NSObject

The superclass of this class.

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

type Result = SCNPhysicsBody

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

impl Debug for SCNPhysicsBody

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

Formats the value using the given formatter.

impl Deref for SCNPhysicsBody

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNPhysicsBody

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 SCNPhysicsBody

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNPhysicsBody

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 SCNPhysicsBody

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 SCNPhysicsBody

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 SCNPhysicsBody

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNPhysicsBody

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 SCNPhysicsBody

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

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

impl DowncastTarget for SCNPhysicsBody

impl Eq for SCNPhysicsBody