Struct GCControllerTouchpad

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

Available on crate features GCControllerElement and GCControllerTouchpad only.

A touchpad is a touch-based two axis input with a notion of “touch state”. It keeps track of whether the touchpad is actively being touched, and generates events based on a change in touch state.

See also Apple’s documentation

Implementations

impl GCControllerTouchpad

pub unsafe fn button(&self) -> Retained<GCControllerButtonInput>

Available on crate feature GCControllerButtonInput only.

Button is the button built into the touch surface.

pub unsafe fn touchDown(&self) -> GCControllerTouchpadHandler

Available on crate feature block2 only.

Called when a touch event begins on the touchpad.

pub unsafe fn setTouchDown(&self, touch_down: GCControllerTouchpadHandler)

Available on crate feature block2 only.

Setter for touchDown.

pub unsafe fn touchMoved(&self) -> GCControllerTouchpadHandler

Available on crate feature block2 only.

Called when a touch event continues on the touchpad, but not when it begins or ends.

pub unsafe fn setTouchMoved(&self, touch_moved: GCControllerTouchpadHandler)

Available on crate feature block2 only.

Setter for touchMoved.

pub unsafe fn touchUp(&self) -> GCControllerTouchpadHandler

Available on crate feature block2 only.

Called when a touch event ends on the touchpad.

pub unsafe fn setTouchUp(&self, touch_up: GCControllerTouchpadHandler)

Available on crate feature block2 only.

Setter for touchUp.

pub unsafe fn touchSurface(&self) -> Retained<GCControllerDirectionPad>

Available on crate feature GCControllerDirectionPad only.

The touch surface is a 2-axis control that represents the position of a touch event on the touchpad.

The axes will indicate the most recent touch position - a non-zero value does not indicate that the surface is being touched, and a value of (0, 0) does not indicate the surface is not being touched.

See: touchState - Should be polled in conjunction with touchSurface to determine if values are valid

pub unsafe fn touchState(&self) -> GCTouchState

Indicates the current state of the touch event on the touchpad.

pub unsafe fn reportsAbsoluteTouchSurfaceValues(&self) -> bool

The touchpad can use the raw position values of its surface as D-pad values, or it can create a virtual dpad centered around the first contact point with the surface.

If NO; a smaller sliding window is created around the initial touch point and subsequent movement is relative to that center. Movement outside the window will slide the window with it to re-center it. This is great for surfaces where there is no clear sense of a middle and drift over time is an issue.

If YES; the absolute values are used and any drift will have to managed manually either through user traning or by a developer using the dpad.

The default value for this property is YES, meaning the touch surface’s raw positional values are reported.

pub unsafe fn setReportsAbsoluteTouchSurfaceValues( &self, reports_absolute_touch_surface_values: bool, )

Setter for reportsAbsoluteTouchSurfaceValues.

pub unsafe fn setValueForXAxis_yAxis_touchDown_buttonValue( &self, x_axis: c_float, y_axis: c_float, touch_down: bool, button_value: c_float, )

Sets the normalized value for the touchpad’s axes, as well as its current touch and button state.

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

See: touchSurface

See: touchState

impl GCControllerTouchpad

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = GCControllerElement>

pub unsafe fn collection(&self) -> Option<Retained<GCControllerElement>>

Each element can be part of a wider collection of inputs that map to a single logical element. A directional pad (dpad) is a logical collection of two axis inputs and thus each axis belongs to the same collection element - the dpad.

pub unsafe fn isAnalog(&self) -> bool

Check if the element can support more than just digital values, such as decimal ranges between 0 and 1. Defaults to YES for most elements.

pub unsafe fn isBoundToSystemGesture(&self) -> bool

Check if the element is bound to a system gesture. Defaults to NO for most elements.

See: preferredSystemGestureState

See: GCSystemGestureState

pub unsafe fn preferredSystemGestureState(&self) -> GCSystemGestureState

The preferred system gesture state for this element. Defaults to GCSystemGestureStateEnabled for most elements

Note: This is merely the preferred system gesture state - it is not guaranteed to be respected by the system.

Note: It is highly recommended to leave this set to the default value, however there may be situations (for example, game streaming apps) where it is preferrable to disable system gestures.

See: boundToSystemGesture

pub unsafe fn setPreferredSystemGestureState( &self, preferred_system_gesture_state: GCSystemGestureState, )

Setter for preferredSystemGestureState.

pub unsafe fn sfSymbolsName(&self) -> Option<Retained<NSString>>

The element’s SF Symbols name, taking input remapping into account.

Note: In almost all instances, you should use this over unmappedSfSymbolsName in your UI.

pub unsafe fn setSfSymbolsName(&self, sf_symbols_name: Option<&NSString>)

Setter for sfSymbolsName.

pub unsafe fn localizedName(&self) -> Option<Retained<NSString>>

The element’s localized name, taking input remapping into account.

Note: In almost all instances, you should use this over unmappedLocalizedName in your UI.

pub unsafe fn setLocalizedName(&self, localized_name: Option<&NSString>)

Setter for localizedName.

pub unsafe fn unmappedSfSymbolsName(&self) -> Option<Retained<NSString>>

The element’s SF Symbols name, not taking any input remapping into account.

Note: Use this in your games own remapping UI, or when you need to prompt a user that a given button has no mapping (sfSymbolsName is nil).

pub unsafe fn setUnmappedSfSymbolsName( &self, unmapped_sf_symbols_name: Option<&NSString>, )

Setter for unmappedSfSymbolsName.

pub unsafe fn unmappedLocalizedName(&self) -> Option<Retained<NSString>>

The element’s localized name, not taking any input remapping into account.

Note: Use this in your games own remapping UI, or when you need to prompt a user that a given button has no mapping (localizedName is nil).

pub unsafe fn setUnmappedLocalizedName( &self, unmapped_localized_name: Option<&NSString>, )

Setter for unmappedLocalizedName.

pub unsafe fn aliases(&self) -> Retained<NSSet<NSString>>

A set of aliases that can be used to access this element with keyed subscript notation.

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 GCControllerTouchpad

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GCControllerElement> for GCControllerTouchpad

fn as_ref(&self) -> &GCControllerElement

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

impl AsRef<GCControllerTouchpad> for GCControllerTouchpad

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GCControllerTouchpad

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GCControllerTouchpad

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<GCControllerElement> for GCControllerTouchpad

fn borrow(&self) -> &GCControllerElement

Immutably borrows from an owned value.

impl Borrow<NSObject> for GCControllerTouchpad

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GCControllerTouchpad

const NAME: &'static str = "GCControllerTouchpad"

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

type Super = GCControllerElement

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for GCControllerTouchpad

type Target = GCControllerElement

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GCControllerTouchpad

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 GCControllerTouchpad

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GCControllerTouchpad

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 GCControllerTouchpad

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 GCControllerTouchpad

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

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

impl DowncastTarget for GCControllerTouchpad

impl Eq for GCControllerTouchpad