Struct GCMotion

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

Available on crate feature GCMotion only.

A profile for getting motion input from a controller that has the ability to measure acceleration and rotation rate.

You check for the availablity of motion inputs by getting the motion property of a controller. If that returns a nil value; motion is not available. A non-nil value is a valid GCMotion profile that is able to provide motion input.

See: GCController.motion

See also Apple’s documentation

Implementations

impl GCMotion

pub unsafe fn controller(&self) -> Option<Retained<GCController>>

Available on crate feature GCController only.

A profile keeps a reference to the controller that it is mapping input from.

See: GCController

pub unsafe fn valueChangedHandler(&self) -> GCMotionValueChangedHandler

Available on crate feature block2 only.

pub unsafe fn setValueChangedHandler( &self, value_changed_handler: GCMotionValueChangedHandler, )

Available on crate feature block2 only.

Setter for valueChangedHandler.

pub unsafe fn sensorsRequireManualActivation(&self) -> bool

If this property is returns YES, you are responsible for setting sensorsActive to YES when you need motion data from the controller.

Some controllers, such as the Siri Remote, automatically activate and deactivate motion sensors. In such a case, this property will return NO.

See: sensorsActive

pub unsafe fn sensorsActive(&self) -> bool

Set this property to YES when you wish to receive motion data from the controller. When you set this property to NO, the motion sensors will be disabled and the GCMotion profile will not be updated.

Note: It is highly recommended that you only enable sensor during the period of time you directly need motion data. Motion sensors can drain controller battery, device battery, and needlessly consume Bluetooth bandwidth.

See: sensorsRequireManualActivation

pub unsafe fn setSensorsActive(&self, sensors_active: bool)

Setter for sensorsActive.

pub unsafe fn hasGravityAndUserAcceleration(&self) -> bool

Returns YES if the controller is capable of reporting gravity and user acceleration separately.

Note: Some controllers do not separate gravity from user acceleration, and only report the total acceleration of the controller. Query whether the connected controller has the ability to separate gravity and user acceleration, and it doesn’t, use acceleration instead.

See: acceleration

pub unsafe fn gravity(&self) -> GCAcceleration

The gravity vector expressed in the controller’s reference frame.

Note that the total acceleration of the controller is equal to gravity plus userAcceleration.

See: userAcceleration

See: acceleration

pub unsafe fn userAcceleration(&self) -> GCAcceleration

The acceleration that the user is giving to the controller.

Note that the total acceleration of the controller is equal to gravity plus userAcceleration.

See: gravity

See: acceleration

pub unsafe fn acceleration(&self) -> GCAcceleration

The total acceleration of the controller.

See: gravity

See: userAcceleration

pub unsafe fn hasAttitudeAndRotationRate(&self) -> bool

👎Deprecated: Use -hasAttitude and -hasRotationRate methods instead

The controller generating the motion data has sensors that can accurately determine the current attitude and rotation rate. If this is enabled the motion data for attitude and rotation rate are usable for inputs.

pub unsafe fn hasAttitude(&self) -> bool

The controller generating the motion data has sensors that can accurately determine the current attitude. If this is enabled the motion data for attitude is usable for inputs.

pub unsafe fn hasRotationRate(&self) -> bool

The controller generating the motion data has sensors that can accurately determine the current rotation rate. If this is enabled the motion data for rotation rate is usable for inputs.

pub unsafe fn attitude(&self) -> GCQuaternion

The current attitude of the controller.

Note: Remotes without accurate attitude and rotation rate can not determine a stable attitude so the values will be (0,0,0,1) at all times.

See: hasAttitude

See: GCMicroGamepad

pub unsafe fn rotationRate(&self) -> GCRotationRate

The current rotation rate of the controller.

Note: Remotes without accurate attitude and rotation rate can not determine a stable rotation rate so the values will be (0,0,0) at all times.

See: hasRotationRate

See: GCMicroGamepad

pub unsafe fn setGravity(&self, gravity: GCAcceleration)

Sets the gravity vector expressed in the controller’s reference frame.

Note: If the controller’s snapshot flag is set to NO, this method has no effect.

See: gravity

pub unsafe fn setUserAcceleration(&self, user_acceleration: GCAcceleration)

Sets the acceleration that the user is giving to the controller.

Note: If the controller’s snapshot flag is set to NO, this method has no effect.

See: userAcceleration

pub unsafe fn setAcceleration(&self, acceleration: GCAcceleration)

Sets the acceleration that the user is giving to the controller.

Note: If the controller’s snapshot flag is set to NO, this method has no effect.

See: userAcceleration

pub unsafe fn setAttitude(&self, attitude: GCQuaternion)

Sets the current rotation rate of the controller.

Note: If the controller’s snapshot flag is set to NO, this method has no effect.

See: attitude

pub unsafe fn setRotationRate(&self, rotation_rate: GCRotationRate)

Sets the current rotation rate of the controller.

Note: If the controller’s snapshot flag is set to NO, this method has no effect.

See: rotationRate

pub unsafe fn setStateFromMotion(&self, motion: &GCMotion)

Sets the state vector of the motion profile to a copy of the input motion profile’s state vector.

Note: If the controller’s snapshot flag is set to NO, this method has no effect.

See: GCController.snapshot

impl GCMotion

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.

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 GCMotion

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GCMotion> for GCMotion

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GCMotion

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GCMotion

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for GCMotion

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GCMotion

const NAME: &'static str = "GCMotion"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<GCMotion 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 Debug for GCMotion

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

Formats the value using the given formatter.

impl Deref for GCMotion

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GCMotion

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 GCMotion

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GCMotion

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 GCMotion

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 GCMotion

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

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

impl DowncastTarget for GCMotion

impl Eq for GCMotion