Struct SKPhysicsBody

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

Available on crate feature SKPhysicsBody only.

A SpriteKit physics body. These are the physical representations of your nodes. These specify the area and mass and any collision masking needed.

All bodies have zero, one or more shapes that define its area. A body with no shapes is ethereal and does not collide with other bodies.

See also Apple’s documentation

Implementations

impl SKPhysicsBody

pub unsafe fn bodyWithCircleOfRadius(r: CGFloat) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-foundation only.

Creates a circle of radius r centered at the node’s origin.

Parameter r: the radius in points

pub unsafe fn bodyWithCircleOfRadius_center( r: CGFloat, center: CGPoint, ) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-foundation only.

Creates a circle of radius r centered at a point in the node’s coordinate space.

Parameter r: the radius in points

pub unsafe fn bodyWithRectangleOfSize(s: CGSize) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-foundation only.

Creates a rectangle of the specified size centered at the node’s origin.

Parameter s: the size in points

pub unsafe fn bodyWithRectangleOfSize_center( s: CGSize, center: CGPoint, ) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-foundation only.

Creates a rectangle of the specified size centered at a point in the node’s coordinate space.

Parameter s: the size in points

pub unsafe fn bodyWithPolygonFromPath(path: &CGPath) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-graphics only.

The path must represent a convex or concave polygon with counter clockwise winding and no self intersection. Positions are relative to the node’s origin.

Parameter path: the path to use

pub unsafe fn bodyWithEdgeFromPoint_toPoint( p1: CGPoint, p2: CGPoint, ) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-foundation only.

Creates an edge from p1 to p2. Edges have no volume and are intended to be used to create static environments. Edges can collide with bodies of volume, but not with each other.

Parameter p1: start point

Parameter p2: end point

pub unsafe fn bodyWithEdgeChainFromPath( path: &CGPath, ) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-graphics only.

Creates an edge chain from a path. The path must have no self intersection. Edges have no volume and are intended to be used to create static environments. Edges can collide with bodies of volume, but not with each other.

Parameter path: the path to use

pub unsafe fn bodyWithEdgeLoopFromPath(path: &CGPath) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-graphics only.

Creates an edge loop from a path. A loop is automatically created by joining the last point to the first. The path must have no self intersection. Edges have no volume and are intended to be used to create static environments. Edges can collide with body’s of volume, but not with each other.

Parameter path: the path to use

pub unsafe fn bodyWithEdgeLoopFromRect(rect: CGRect) -> Retained<SKPhysicsBody>

Available on crate feature objc2-core-foundation only.

Creates an edge loop from a CGRect. Edges have no volume and are intended to be used to create static environments. Edges can collide with body’s of volume, but not with each other.

Parameter rect: the CGRect to use

pub unsafe fn bodyWithTexture_size( texture: &SKTexture, size: CGSize, ) -> Retained<SKPhysicsBody>

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

Creates a body from the alpha values in the supplied texture.

Parameter texture: the texture to be interpreted

Parameter size: of the generated physics body

pub unsafe fn bodyWithTexture_alphaThreshold_size( texture: &SKTexture, alpha_threshold: c_float, size: CGSize, ) -> Retained<SKPhysicsBody>

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

Creates a body from the alpha values in the supplied texture.

Parameter texture: the texture to be interpreted

Parameter alphaThreshold: the alpha value above which a pixel is interpreted as opaque

Parameter size: of the generated physics body

pub unsafe fn bodyWithBodies( bodies: &NSArray<SKPhysicsBody>, ) -> Retained<SKPhysicsBody>

Creates an compound body that is the union of the bodies used to create it.

pub unsafe fn isDynamic(&self) -> bool

pub unsafe fn setDynamic(&self, dynamic: bool)

Setter for isDynamic.

pub unsafe fn usesPreciseCollisionDetection(&self) -> bool

pub unsafe fn setUsesPreciseCollisionDetection( &self, uses_precise_collision_detection: bool, )

Setter for usesPreciseCollisionDetection.

pub unsafe fn allowsRotation(&self) -> bool

pub unsafe fn setAllowsRotation(&self, allows_rotation: bool)

Setter for allowsRotation.

pub unsafe fn pinned(&self) -> bool

pub unsafe fn setPinned(&self, pinned: bool)

Setter for pinned.

pub unsafe fn isResting(&self) -> bool

If the physics simulation has determined that this body is at rest it may set the resting property to YES. Resting bodies do not participate in the simulation until some collision with a non-resting object, or an impulse is applied, that unrests it. If all bodies in the world are resting then the simulation as a whole is “at rest”.

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

Setter for isResting.

pub unsafe fn friction(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Determines the ‘roughness’ for the surface of the physics body (0.0 - 1.0). Defaults to 0.2

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

Available on crate feature objc2-core-foundation only.

Setter for friction.

pub unsafe fn charge(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Specifies the charge on the body. Charge determines the degree to which a body is affected by electric and magnetic fields. Note that this is a unitless quantity, it is up to the developer to set charge and field strength appropriately. Defaults to 0.0

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

Available on crate feature objc2-core-foundation only.

Setter for charge.

pub unsafe fn restitution(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Determines the ‘bounciness’ of the physics body (0.0 - 1.0). Defaults to 0.2

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

Available on crate feature objc2-core-foundation only.

Setter for restitution.

pub unsafe fn linearDamping(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Optionally reduce the body’s linear velocity each frame to simulate fluid/air friction. Value should be zero or greater. Defaults to 0.1. Used in conjunction with per frame impulses, an object can be made to move at a constant speed. For example, if an object 64 points in size and default density and a linearDamping of 25 will slide across the screen in a few seconds if an impulse of magnitude 10 is applied every update.

pub unsafe fn setLinearDamping(&self, linear_damping: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for linearDamping.

pub unsafe fn angularDamping(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Optionally reduce the body’s angular velocity each frame to simulate rotational friction. (0.0 - 1.0). Defaults to 0.1

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

Available on crate feature objc2-core-foundation only.

Setter for angularDamping.

pub unsafe fn density(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The density of the body.

The unit is arbitrary, as long as the relative densities are consistent throughout the application. Note that density and mass are inherently related (they are directly proportional), so changing one also changes the other. Both are provided so either can be used depending on what is more relevant to your usage.

pub unsafe fn setDensity(&self, density: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for density.

pub unsafe fn mass(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The mass of the body.

The unit is arbitrary, as long as the relative masses are consistent throughout the application. Note that density and mass are inherently related (they are directly proportional), so changing one also changes the other. Both are provided so either can be used depending on what is more relevant to your usage.

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

Available on crate feature objc2-core-foundation only.

Setter for mass.

pub unsafe fn area(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

The area of the body.

The unit is arbitrary, as long as the relative areas are consistent throughout the application.

pub unsafe fn affectedByGravity(&self) -> bool

Bodies are affected by field forces such as gravity if this property is set and the field’s category mask is set appropriately. The default value is YES.

If this is set a force is applied to the object based on the mass. Set the field force vector in the scene to modify the strength of the force.

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

Setter for affectedByGravity.

pub unsafe fn fieldBitMask(&self) -> u32

Defines what logical ‘categories’ of fields this body responds to. Defaults to all bits set (all categories). Can be forced off via affectedByGravity.

pub unsafe fn setFieldBitMask(&self, field_bit_mask: u32)

Setter for fieldBitMask.

pub unsafe fn categoryBitMask(&self) -> u32

Defines what logical ‘categories’ this body belongs to. Defaults to all bits set (all categories).

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

Setter for categoryBitMask.

pub unsafe fn collisionBitMask(&self) -> u32

Defines what logical ‘categories’ of bodies this body responds to collisions with. Defaults to all bits set (all categories).

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

Setter for collisionBitMask.

pub unsafe fn contactTestBitMask(&self) -> u32

Defines what logical ‘categories’ of bodies this body generates intersection notifications with. Defaults to all bits cleared (no categories).

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

Setter for contactTestBitMask.

pub unsafe fn joints(&self) -> Retained<NSArray<SKPhysicsJoint>>

Available on crate feature SKPhysicsJoint only.

pub unsafe fn node(&self, mtm: MainThreadMarker) -> Option<Retained<SKNode>>

Available on crate feature SKNode and crate feature objc2-app-kit and macOS only.

The representedObject this physicsBody is currently bound to, or nil if it is not.

pub unsafe fn velocity(&self) -> CGVector

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

Setter for velocity.

pub unsafe fn angularVelocity(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

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

Available on crate feature objc2-core-foundation only.

Setter for angularVelocity.

pub unsafe fn applyForce(&self, force: CGVector)

Available on crate feature objc2-core-foundation only.

pub unsafe fn applyForce_atPoint(&self, force: CGVector, point: CGPoint)

Available on crate feature objc2-core-foundation only.

pub unsafe fn applyTorque(&self, torque: CGFloat)

Available on crate feature objc2-core-foundation only.

pub unsafe fn applyImpulse(&self, impulse: CGVector)

Available on crate feature objc2-core-foundation only.

pub unsafe fn applyImpulse_atPoint(&self, impulse: CGVector, point: CGPoint)

Available on crate feature objc2-core-foundation only.

pub unsafe fn applyAngularImpulse(&self, impulse: CGFloat)

Available on crate feature objc2-core-foundation only.

pub unsafe fn allContactedBodies(&self) -> Retained<NSArray<SKPhysicsBody>>

impl SKPhysicsBody

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 SKPhysicsBody

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SKPhysicsBody

fn as_ref(&self) -> &NSObject

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

impl AsRef<SKPhysicsBody> for SKPhysicsBody

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SKPhysicsBody

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SKPhysicsBody

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SKPhysicsBody

const NAME: &'static str = "SKPhysicsBody"

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

type Super = NSObject

The superclass of this class.

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

type Result = SKPhysicsBody

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

impl Debug for SKPhysicsBody

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

Formats the value using the given formatter.

impl Deref for SKPhysicsBody

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SKPhysicsBody

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 SKPhysicsBody

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SKPhysicsBody

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 SKPhysicsBody

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 SKPhysicsBody

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 SKPhysicsBody

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SKPhysicsBody

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 SKPhysicsBody

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

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

impl DowncastTarget for SKPhysicsBody

impl Eq for SKPhysicsBody