Struct GKCompositeBehavior 

pub struct GKCompositeBehavior { /* private fields */ }

Available on crate features GKBehavior and GKCompositeBehavior only.

Apple’s documentation

Implementations

impl GKCompositeBehavior

pub unsafe fn behaviorCount(&self) -> NSInteger

Number of sub-behaviors in this behavior

pub unsafe fn behaviorWithBehaviors( behaviors: &NSArray<GKBehavior>, ) -> Retained<Self>

Creates a behavior with an array of sub-behaviors

pub unsafe fn behaviorWithBehaviors_andWeights( behaviors: &NSArray<GKBehavior>, weights: &NSArray<NSNumber>, ) -> Retained<Self>

Creates a behavior with two associated arrays of sub-behaviors and weights

pub unsafe fn setWeight_forBehavior( &self, weight: c_float, behavior: &GKBehavior, )

Adds a new sub-behavior or changes the weight of the existing sub-behavior in this behavior. If the sub-behavior does not exist in this behavior, it is added.

Parameter weight: the weight for this goal

Parameter behavior: the sub-behavior who’s weight to change

pub unsafe fn weightForBehavior(&self, behavior: &GKBehavior) -> c_float

Gets the current weight for a given sub-behavior.

Returns: the weight of the sub-behavior, or 0 if there is no such sub-behavior on this behavior

pub unsafe fn removeBehavior(&self, behavior: &GKBehavior)

Remove the indicated sub-behavior from this behavior.

Parameter behavior: the sub-behavior to be removed

pub unsafe fn removeAllBehaviors(&self)

Removes all the sub-behavior on the behavior.

pub unsafe fn objectAtIndexedSubscript( &self, idx: NSUInteger, ) -> Retained<GKBehavior>

Supports getting behaviors via a [int] subscript.

pub unsafe fn setObject_forKeyedSubscript( &self, weight: &NSNumber, behavior: &GKBehavior, )

Supports setting a weight via a [behavior] subscript.

pub unsafe fn objectForKeyedSubscript( &self, behavior: &GKBehavior, ) -> Retained<NSNumber>

Supports getting a weight via a [behavior] subscript.

impl GKCompositeBehavior

Methods declared on superclass GKBehavior.

pub unsafe fn behaviorWithGoal_weight( goal: &GKGoal, weight: c_float, ) -> Retained<Self>

Available on crate feature GKGoal only.

Creates a behavior with a single goal and weight

pub unsafe fn behaviorWithGoals(goals: &NSArray<GKGoal>) -> Retained<Self>

Available on crate feature GKGoal only.

Creates a behavior with an array of goals. All weights are set to 1.0f

pub unsafe fn behaviorWithGoals_andWeights( goals: &NSArray<GKGoal>, weights: &NSArray<NSNumber>, ) -> Retained<Self>

Available on crate feature GKGoal only.

Creates a behavior with two associated arrays of goals and weights

pub unsafe fn behaviorWithWeightedGoals( weighted_goals: &NSDictionary<GKGoal, NSNumber>, ) -> Retained<Self>

Available on crate feature GKGoal only.

Creates a behavior with a dictionary of goal/weight pairs

impl GKCompositeBehavior

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = GKBehavior>

pub unsafe fn goalCount(&self) -> NSInteger

pub unsafe fn setWeight_forGoal(&self, weight: c_float, goal: &GKGoal)

Available on crate feature GKGoal only.

Adds a new goal or changes the weight of the existing goal in this behavior. If the goal does not exist in this behavior, it is added.

Parameter weight: the weight for this goal

Parameter goal: the goal who’s weight to change

pub unsafe fn weightForGoal(&self, goal: &GKGoal) -> c_float

Available on crate feature GKGoal only.

Gets the current weight for a given goal.

Returns: the weight of the goal, or 0 if there is no such goal on this behavior

pub unsafe fn removeGoal(&self, goal: &GKGoal)

Available on crate feature GKGoal only.

Remove the indicated goal from this behavior.

Parameter goal: the goal to be removed

pub unsafe fn removeAllGoals(&self)

Removes all the goals on the behavior.

pub unsafe fn objectAtIndexedSubscript( &self, idx: NSUInteger, ) -> Retained<GKGoal>

Available on crate feature GKGoal only.

Supports getting goals via a [int] subscript.

pub unsafe fn setObject_forKeyedSubscript( &self, weight: &NSNumber, goal: &GKGoal, )

Available on crate feature GKGoal only.

Supports setting a weight via a [goal] subscript.

pub unsafe fn objectForKeyedSubscript( &self, goal: &GKGoal, ) -> Option<Retained<NSNumber>>

Available on crate feature GKGoal only.

Supports getting a weight via a [goal] subscript.

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 GKCompositeBehavior

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GKBehavior> for GKCompositeBehavior

fn as_ref(&self) -> &GKBehavior

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

impl AsRef<GKCompositeBehavior> for GKCompositeBehavior

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GKCompositeBehavior

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GKCompositeBehavior

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<GKBehavior> for GKCompositeBehavior

fn borrow(&self) -> &GKBehavior

Immutably borrows from an owned value.

impl Borrow<NSObject> for GKCompositeBehavior

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GKCompositeBehavior

const NAME: &'static str = "GKCompositeBehavior"

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

type Super = GKBehavior

The superclass of this class.

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

type Result = GKCompositeBehavior

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

impl Debug for GKCompositeBehavior

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

Formats the value using the given formatter.

impl Deref for GKCompositeBehavior

type Target = GKBehavior

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GKCompositeBehavior

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 GKCompositeBehavior

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for GKCompositeBehavior

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 NSFastEnumeration for GKCompositeBehavior

unsafe fn countByEnumeratingWithState_objects_count( &self, state: NonNull<NSFastEnumerationState>, buffer: NonNull<*mut AnyObject>, len: usize, ) -> usize

where Self: Sized + Message,

Safety

impl NSObjectProtocol for GKCompositeBehavior

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 PartialEq for GKCompositeBehavior

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 GKCompositeBehavior

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

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

impl DowncastTarget for GKCompositeBehavior

impl Eq for GKCompositeBehavior