Struct GCControllerButtonInput

Source

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

Available on crate features GCControllerButtonInput and GCControllerElement only.

Expand description

Apple’s documentation

Implementations§

Source §

impl GCControllerButtonInput

Source

pub unsafe fn valueChangedHandler( &self, ) -> GCControllerButtonValueChangedHandler

Available on crate feature block2 only.

Source

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

Available on crate feature block2 only.

Setter for valueChangedHandler.

Source

pub unsafe fn pressedChangedHandler( &self, ) -> GCControllerButtonValueChangedHandler

Available on crate feature block2 only.

Set this block if you want to be notified when only the pressed state on this button changes. This will get called less often than the valueChangedHandler with the additional feature of the pressed state being different to the last time it was called.

Source

pub unsafe fn setPressedChangedHandler( &self, pressed_changed_handler: GCControllerButtonValueChangedHandler, )

Available on crate feature block2 only.

Setter for pressedChangedHandler.

Source

pub unsafe fn touchedChangedHandler( &self, ) -> GCControllerButtonTouchedChangedHandler

Available on crate feature block2 only.

Source

pub unsafe fn setTouchedChangedHandler( &self, touched_changed_handler: GCControllerButtonTouchedChangedHandler, )

Available on crate feature block2 only.

Setter for touchedChangedHandler.

Source

pub unsafe fn value(&self) -> c_float

A normalized value for the input. Between 0 and 1 for button inputs. Values are saturated and thus never exceed the range of [0, 1].

See: valueChangedHandler

See: pressed

Source

pub unsafe fn isPressed(&self) -> bool

Buttons are mostly used in a digital sense, thus we have a recommended method for checking for pressed state instead of interpreting the value.

As a general guideline a button is pressed if the value exceeds 0. However there may be hysterisis applied to counter noisy input values, thus incidental values around the threshold value may not trigger a change in pressed state.

Others buttons may support two-stage actuation, where the button reports a value between 0 and 1 but is only considered pressed when its value is greater than some threshold other than 0.

See: pressedChangedHandler

See: value

Source

pub unsafe fn isTouched(&self) -> bool

Some buttons feature capacitive touch capabilities where the user can touch the button without pressing it. In such cases, a button will be touched before it is pressed.

For buttons without capacitive sensing, the touched state is true if the value exceeds 0.

See: touchChangedHandler

See: pressed

Source

pub unsafe fn setValue(&self, value: c_float)

Sets the normalized value for the button input. Will update the pressed state of the button.

Parameter value: the value to set the input to.

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

See: value

Source §

impl GCControllerButtonInput

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = GCControllerElement>§

Source

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.

Source

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.

Source

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

Source

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

Source

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

Setter for preferredSystemGestureState.

Source

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.

Source

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

Setter for sfSymbolsName.

Source

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.

Source

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

Setter for localizedName.

Source

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).

Source

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

Setter for unmappedSfSymbolsName.

Source

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).

Source

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

Setter for unmappedLocalizedName.

Source

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>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}