#[repr(C)]pub struct GCControllerAxisInput { /* private fields */ }
GCControllerAxisInput
and GCControllerElement
only.Expand description
Implementations§
Source§impl GCControllerAxisInput
impl GCControllerAxisInput
pub unsafe fn valueChangedHandler(&self) -> GCControllerAxisValueChangedHandler
block2
only.Sourcepub unsafe fn setValueChangedHandler(
&self,
value_changed_handler: GCControllerAxisValueChangedHandler,
)
Available on crate feature block2
only.
pub unsafe fn setValueChangedHandler( &self, value_changed_handler: GCControllerAxisValueChangedHandler, )
block2
only.Setter for valueChangedHandler
.
Sourcepub unsafe fn value(&self) -> c_float
pub unsafe fn value(&self) -> c_float
A normalized value for the input, between -1 and 1 for axis inputs. The values are deadzoned and saturated before they are returned so there is no value ouside the range. Deadzoning does not remove values from the range, the full 0 to 1 magnitude of values are possible from the input.
As an axis is often used in a digital sense, you can rely on a value of 0 meaning the axis is inside the deadzone. Any value greater than or less than zero is not in the deadzone.
Methods from Deref<Target = GCControllerElement>§
Sourcepub unsafe fn collection(&self) -> Option<Retained<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.
Sourcepub unsafe fn isAnalog(&self) -> bool
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.
Sourcepub unsafe fn isBoundToSystemGesture(&self) -> bool
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
Sourcepub unsafe fn preferredSystemGestureState(&self) -> 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
Sourcepub unsafe fn setPreferredSystemGestureState(
&self,
preferred_system_gesture_state: GCSystemGestureState,
)
pub unsafe fn setPreferredSystemGestureState( &self, preferred_system_gesture_state: GCSystemGestureState, )
Setter for preferredSystemGestureState
.
Sourcepub unsafe fn sfSymbolsName(&self) -> Option<Retained<NSString>>
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.
Sourcepub unsafe fn setSfSymbolsName(&self, sf_symbols_name: Option<&NSString>)
pub unsafe fn setSfSymbolsName(&self, sf_symbols_name: Option<&NSString>)
Setter for sfSymbolsName
.
Sourcepub unsafe fn localizedName(&self) -> Option<Retained<NSString>>
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.
Sourcepub unsafe fn setLocalizedName(&self, localized_name: Option<&NSString>)
pub unsafe fn setLocalizedName(&self, localized_name: Option<&NSString>)
Setter for localizedName
.
Sourcepub unsafe fn unmappedSfSymbolsName(&self) -> Option<Retained<NSString>>
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).
Sourcepub unsafe fn setUnmappedSfSymbolsName(
&self,
unmapped_sf_symbols_name: Option<&NSString>,
)
pub unsafe fn setUnmappedSfSymbolsName( &self, unmapped_sf_symbols_name: Option<&NSString>, )
Setter for unmappedSfSymbolsName
.
Sourcepub unsafe fn unmappedLocalizedName(&self) -> Option<Retained<NSString>>
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).
Sourcepub unsafe fn setUnmappedLocalizedName(
&self,
unmapped_localized_name: Option<&NSString>,
)
pub unsafe fn setUnmappedLocalizedName( &self, unmapped_localized_name: Option<&NSString>, )
Setter for unmappedLocalizedName
.
Methods from Deref<Target = NSObject>§
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesn’t recognize.
See Apple’s documentation for details.
Methods from Deref<Target = AnyObject>§
Sourcepub fn class(&self) -> &'static AnyClass
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());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
👎Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
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.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
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§
Source§impl AsRef<AnyObject> for GCControllerAxisInput
impl AsRef<AnyObject> for GCControllerAxisInput
Source§impl AsRef<GCControllerElement> for GCControllerAxisInput
impl AsRef<GCControllerElement> for GCControllerAxisInput
Source§fn as_ref(&self) -> &GCControllerElement
fn as_ref(&self) -> &GCControllerElement
Source§impl AsRef<NSObject> for GCControllerAxisInput
impl AsRef<NSObject> for GCControllerAxisInput
Source§impl Borrow<AnyObject> for GCControllerAxisInput
impl Borrow<AnyObject> for GCControllerAxisInput
Source§impl Borrow<GCControllerElement> for GCControllerAxisInput
impl Borrow<GCControllerElement> for GCControllerAxisInput
Source§fn borrow(&self) -> &GCControllerElement
fn borrow(&self) -> &GCControllerElement
Source§impl Borrow<NSObject> for GCControllerAxisInput
impl Borrow<NSObject> for GCControllerAxisInput
Source§impl ClassType for GCControllerAxisInput
impl ClassType for GCControllerAxisInput
Source§const NAME: &'static str = "GCControllerAxisInput"
const NAME: &'static str = "GCControllerAxisInput"
Source§type Super = GCControllerElement
type Super = GCControllerElement
Source§type ThreadKind = <<GCControllerAxisInput as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<GCControllerAxisInput as ClassType>::Super as ClassType>::ThreadKind
Source§impl Debug for GCControllerAxisInput
impl Debug for GCControllerAxisInput
Source§impl Deref for GCControllerAxisInput
impl Deref for GCControllerAxisInput
Source§impl Hash for GCControllerAxisInput
impl Hash for GCControllerAxisInput
Source§impl Message for GCControllerAxisInput
impl Message for GCControllerAxisInput
Source§impl NSObjectProtocol for GCControllerAxisInput
impl NSObjectProtocol for GCControllerAxisInput
Source§fn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Source§fn hash(&self) -> usize
fn hash(&self) -> usize
Source§fn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Source§fn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref