Struct SCNPhysicsField

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

Available on crate feature SCNPhysicsField only.

SCNPhysicsField is an abstract class that describes a force field that applies in the physics world.

See also Apple’s documentation

Implementations

impl SCNPhysicsField

pub unsafe fn strength(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setStrength(&self, strength: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for strength.

pub unsafe fn falloffExponent(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setFalloffExponent(&self, falloff_exponent: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for falloffExponent.

pub unsafe fn minimumDistance(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setMinimumDistance(&self, minimum_distance: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for minimumDistance.

pub unsafe fn isActive(&self) -> bool

pub unsafe fn setActive(&self, active: bool)

Setter for isActive.

pub unsafe fn isExclusive(&self) -> bool

pub unsafe fn setExclusive(&self, exclusive: bool)

Setter for isExclusive.

pub unsafe fn halfExtent(&self) -> SCNVector3

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

pub unsafe fn setHalfExtent(&self, half_extent: SCNVector3)

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

Setter for halfExtent.

pub unsafe fn usesEllipsoidalExtent(&self) -> bool

pub unsafe fn setUsesEllipsoidalExtent(&self, uses_ellipsoidal_extent: bool)

Setter for usesEllipsoidalExtent.

pub unsafe fn scope(&self) -> SCNPhysicsFieldScope

pub unsafe fn setScope(&self, scope: SCNPhysicsFieldScope)

Setter for scope.

pub unsafe fn offset(&self) -> SCNVector3

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

pub unsafe fn setOffset(&self, offset: SCNVector3)

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

Setter for offset.

pub unsafe fn direction(&self) -> SCNVector3

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

pub unsafe fn setDirection(&self, direction: SCNVector3)

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

Setter for direction.

pub unsafe fn categoryBitMask(&self) -> NSUInteger

Determines the node physicsBody’s categories that will be influenced by the receiver. Defaults to all bit set.

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

Setter for categoryBitMask.

pub unsafe fn dragField() -> Retained<SCNPhysicsField>

Slows an object proportionally to the object’s velocity. Use this to simulate effects such as friction from motion through the air.

pub unsafe fn vortexField() -> Retained<SCNPhysicsField>

Applies a force tangential to the direction from the sample point to the field’s position. The force will be CCW to the direction. Make the strength negative to apply force in the CW direction. Amount is proportional to distance from center and the object’s mass. Use this to create effects such as tornadoes.

pub unsafe fn radialGravityField() -> Retained<SCNPhysicsField>

Applies a force in the direction of the origin of the field in local space. To repel objects, use a negative strength. The force is proportional to the distance from the field origin. Varies with the mass of the object according to F = ma The field node’s rotation property can be used to orient the gravity in a particular direction.

pub unsafe fn linearGravityField() -> Retained<SCNPhysicsField>

Applies a force in the direction of the “direction” vector in the local space. To repel objects, use a negative strength. The force is the same everywhere in the field. Varies with the mass of the object according to F = ma The field node’s rotation property can be used to orient the gravity in a particular direction.

pub unsafe fn noiseFieldWithSmoothness_animationSpeed( smoothness: CGFloat, speed: CGFloat, ) -> Retained<SCNPhysicsField>

Available on crate feature objc2-core-foundation only.

A time varying differentiable Perlin simplex noise field. A smoothness of 0 means as noisy as possible. Use this to simulate such effects as fireflies, or snow. To freeze the noise in place, set animationSpeed to 0.0. Mass is ignored. You can change the “smoothness” and “animationSpeed” using KVC.

pub unsafe fn turbulenceFieldWithSmoothness_animationSpeed( smoothness: CGFloat, speed: CGFloat, ) -> Retained<SCNPhysicsField>

Available on crate feature objc2-core-foundation only.

Just like Noise, except the strength of the noise is proportional to the velocity of the object in the field.

pub unsafe fn springField() -> Retained<SCNPhysicsField>

A Hooke’s law force - a force linearly proportional to distance from the center of the field. An object in this field will oscillate with a period proportional to the inverse of the mass. An example use is to keep objects confined to a particular region.

pub unsafe fn electricField() -> Retained<SCNPhysicsField>

A force proportional to the charge on the object. An example use of this field is to make objects behavior differently from one another when they enter a region, or to make an object’s behavior different than its mass based behavior This field models the first part of the Lorentz equation, F = qE

pub unsafe fn magneticField() -> Retained<SCNPhysicsField>

A force proportional to the charge on the object and the object’s velocity. An example use of this field is to make objects behavior differently from one another when they enter a region, or to make an object’s behavior different than its mass based behavior This field models the second part of the Lorentz equation, F = qvB

pub unsafe fn customFieldWithEvaluationBlock( block: SCNFieldForceEvaluator, ) -> Retained<SCNPhysicsField>

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

A field force with a custom force evaluator.

impl SCNPhysicsField

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 SCNPhysicsField

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCNPhysicsField

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCNPhysicsField> for SCNPhysicsField

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCNPhysicsField

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCNPhysicsField

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCNPhysicsField

const NAME: &'static str = "SCNPhysicsField"

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

type Super = NSObject

The superclass of this class.

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

type Result = SCNPhysicsField

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

impl Debug for SCNPhysicsField

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

Formats the value using the given formatter.

impl Deref for SCNPhysicsField

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCNPhysicsField

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 SCNPhysicsField

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SCNPhysicsField

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 SCNPhysicsField

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 SCNPhysicsField

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 SCNPhysicsField

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SCNPhysicsField

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 SCNPhysicsField

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

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

impl DowncastTarget for SCNPhysicsField

impl Eq for SCNPhysicsField