Struct GKAgent 

pub struct GKAgent { /* private fields */ }

Available on crate features GKAgent and GKComponent only.

An agent is a point mass whose local coordinate system is aligned to its velocity. Agents have a variety of steering functions that can be used to simulate vehicles or entities with agency. The units of mass, velocity and radius are dimensionless but related. The visual representation of these values are specific to each game’s own situation.

Values close to 1.0 should be canonical and are expected to yield pleasing results. When applied to visuals these values should be scaled and biased into their target coordinate system and a simple filter on top ensures any noise generated from the steering logic doesn’t affect the visual represtentation.

See also Apple’s documentation

Implementations

impl GKAgent

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn GKAgentDelegate>>>

Object which has agentDidUpdate called on it during this agent’s behavior updatekbeha

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn GKAgentDelegate>>, )

Setter for delegate.

This is a weak property.

pub unsafe fn behavior(&self) -> Option<Retained<GKBehavior>>

Available on crate feature GKBehavior only.

The behavior to apply when updateWithDeltaTime is called. All forces from the goals in the behavior are summed and then applied.

pub unsafe fn setBehavior(&self, behavior: Option<&GKBehavior>)

Available on crate feature GKBehavior only.

Setter for behavior.

pub unsafe fn mass(&self) -> c_float

Agent’s mass. Used for agent impulse application purposes.

Defaults to 1.0

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

Setter for mass.

pub unsafe fn radius(&self) -> c_float

Radius of the agent’s bounding circle. Used by the agent avoid steering functions.

Defaults to 0.5 for a canonical diameter of 1.0

pub unsafe fn setRadius(&self, radius: c_float)

Setter for radius.

pub unsafe fn speed(&self) -> c_float

Current speed of the agent along its foward direction.

Defaults to 0.0

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

Setter for speed.

pub unsafe fn maxAcceleration(&self) -> c_float

Maximum amount of acceleration that can be applied to this agent. All applied impulses are clipped to this amount.

Defaults to 1.0

pub unsafe fn setMaxAcceleration(&self, max_acceleration: c_float)

Setter for maxAcceleration.

pub unsafe fn maxSpeed(&self) -> c_float

Maximum speed of this agent. Impulses cannot cause the agents speed to ever be greater than this value.

Defaults to 1.0

pub unsafe fn setMaxSpeed(&self, max_speed: c_float)

Setter for maxSpeed.

impl GKAgent

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = GKComponent>

pub unsafe fn entity(&self) -> Option<Retained<GKEntity>>

Available on crate feature GKEntity only.

The entity that this component belongs to. Defaults to nil until the component is added to an entity.

pub unsafe fn updateWithDeltaTime(&self, seconds: NSTimeInterval)

Updates the component with the given delta time since the last update. Each component should perform its time-based logic in this method.

pub unsafe fn didAddToEntity(&self)

Override this to perform game logic when this component is added to an entity

pub unsafe fn willRemoveFromEntity(&self)

Override this to perform game logic before this entity is removed from it’s entity

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 GKAgent

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GKAgent> for GKAgent

fn as_ref(&self) -> &Self

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

impl AsRef<GKAgent> for GKAgent2D

fn as_ref(&self) -> &GKAgent

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

impl AsRef<GKAgent> for GKAgent3D

fn as_ref(&self) -> &GKAgent

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

impl AsRef<GKComponent> for GKAgent

fn as_ref(&self) -> &GKComponent

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

impl AsRef<NSObject> for GKAgent

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GKAgent

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<GKAgent> for GKAgent2D

fn borrow(&self) -> &GKAgent

Immutably borrows from an owned value.

impl Borrow<GKAgent> for GKAgent3D

fn borrow(&self) -> &GKAgent

Immutably borrows from an owned value.

impl Borrow<GKComponent> for GKAgent

fn borrow(&self) -> &GKComponent

Immutably borrows from an owned value.

impl Borrow<NSObject> for GKAgent

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GKAgent

const NAME: &'static str = "GKAgent"

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

type Super = GKComponent

The superclass of this class.

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

type Result = GKAgent

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

impl Debug for GKAgent

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

Formats the value using the given formatter.

impl Deref for GKAgent

type Target = GKComponent

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GKAgent

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 GKAgent

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for GKAgent

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 GKAgent

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 GKAgent

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 GKAgent

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for GKAgent

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 GKAgent

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

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

impl DowncastTarget for GKAgent

impl Eq for GKAgent