Struct GCDualSenseAdaptiveTrigger

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

Available on crate features GCControllerButtonInput and GCControllerElement and GCDualSenseAdaptiveTrigger only.

DualSense triggers are required to be analog inputs. Common uses would be acceleration and decelleration in a driving game for example.

GCDualSenseAdaptiveTrigger represents an adaptive trigger on the Sony DualSense controller, allowing you to specify a dynamic resistance force that is applied when pulling the trigger. This can, for example, be used to emulate the feeling of pulling back a bow string, firing a weapon, or pulling a lever.

See: GCDualSenseGamepad

See also Apple’s documentation

Implementations

impl GCDualSenseAdaptiveTrigger

pub unsafe fn mode(&self) -> GCDualSenseAdaptiveTriggerMode

The mode that the adaptive trigger is currently in. This property reflects the physical state of the triggers - and requires a response from the controller. It does not update immediately after calling -[GCDualSenseAdaptiveTrigger setMode…].

See: GCDualSenseAdaptiveTriggerMode

pub unsafe fn status(&self) -> GCDualSenseAdaptiveTriggerStatus

The current status of the adaptive trigger - whether it is ready to apply a load, is currently applying a load, or has finished applying a load.

See: GCDualSenseAdaptiveTriggerStatus

pub unsafe fn armPosition(&self) -> c_float

A normalized float from [0-1], with 0 representing the lowest possible trigger arm position and 1 representing the maximum trigger arm position.

See: GCDualSenseAdaptiveTriggerStatus

pub unsafe fn setModeSlopeFeedbackWithStartPosition_endPosition_startStrength_endStrength( &self, start_position: c_float, end_position: c_float, start_strength: c_float, end_strength: c_float, )

Sets the adaptive trigger to slope feedback mode. The start position, end position, start strength, and end strength of the effect can be set arbitrarily; however the end position must be larger than the start position. The trigger arm will provide a linearly interpolated degree of feedback whenever it is depressed between the start and end positions based on the starting and ending strengths.

Parameter startPosition: - A normalized float from [0-1], with 0 representing the smallest possible trigger depression and 1 representing the maximum trigger depression. The effect will begin once the trigger is depressed beyond this point.

Parameter endPosition: - A normalized float from [0-1], with 0 representing the smallest possible depression and 1 representing the maximum trigger depression. Must be greater than startPosition. The effect will end once the trigger is depressed beyond this point.

Parameter startStrength: - A normalized float from [0-1], with 0 representing the minimum effect strength (off entirely) and 1 representing the maximum effect strength. The effect will begin at startStrength once the trigger is depressed beyond startPosition.

Parameter endStrength: - A normalized float from [0-1], with 0 representing the minimum effect strength (off entirely) and 1 representing the maximum effect strength. The effect will end at endStrength once the trigger is depressed to endPosition.

pub unsafe fn setModeFeedbackWithStartPosition_resistiveStrength( &self, start_position: c_float, resistive_strength: c_float, )

Sets the adaptive trigger to feedback mode. The start position and strength of the effect can be set arbitrarily. The trigger arm will continue to provide a constant degree of feedback whenever it is depressed further than the start position.

Parameter startPosition: - A normalized float from [0-1], with 0 representing the smallest possible trigger depression and 1 representing the maximum trigger depression.

Parameter resistiveStrength: - A normalized float from [0-1], with 0 representing the minimum effect strength (off entirely) and 1 representing the maximum effect strength.

pub unsafe fn setModeFeedbackWithResistiveStrengths( &self, positional_resistive_strengths: GCDualSenseAdaptiveTriggerPositionalResistiveStrengths, )

Sets the adaptive trigger to feedback mode. The strength of the effect can be set for each possible trigger position. The trigger arm will provide a degree of feedback based on the resistive strength for a given position.

Parameter positionalResistiveStrengths: - Positional normalized floats from [0-1], with 0 representing the minimum effect strength (off entirely) and 1 representing the maximum effect strength.

pub unsafe fn setModeWeaponWithStartPosition_endPosition_resistiveStrength( &self, start_position: c_float, end_position: c_float, resistive_strength: c_float, )

Sets the adaptive trigger to weapon mode. The start position, end position, and strength of the effect can be set arbitrarily; however the end position must be larger than the start position. The trigger arm will continue to provide a constant degree of feedback whenever it is depressed further than the start position. Once the trigger arm has been depressed past the end position, the strength of the effect will immediately fall to zero, providing a “sense of release” similar to that provided by pulling the trigger of a weapon.

Parameter startPosition: - A normalized float from [0-1], with 0 representing the smallest possible depression and 1 representing the maximum trigger depression. The effect will begin once the trigger is depressed beyond this point.

Parameter endPosition: - A normalized float from [0-1], with 0 representing the smallest possible depression and 1 representing the maximum trigger depression. Must be greater than startPosition. The effect will end once the trigger is depressed beyond this point.

Parameter resistiveStrength: - A normalized float from [0-1], with 0 representing the minimum effect strength (off entirely) and 1 representing the maximum effect strength.

pub unsafe fn setModeVibrationWithStartPosition_amplitude_frequency( &self, start_position: c_float, amplitude: c_float, frequency: c_float, )

Sets the adaptive trigger to vibration mode. The start position, amplitude, and frequency of the effect can be set arbitrarily. The trigger arm will continue to strike against the trigger whenever it is depressed further than the start position, providing a “sense of vibration”.

Parameter startPosition: - A normalized float from [0-1], with 0 representing the smallest possible depression and 1 representing the maximum trigger depression. The effect will begin once the trigger is depressed beyond this point.

Parameter amplitude: - A normalized float from [0-1], with 0 representing the minimum effect strength (off entirely) and 1 representing the maximum effect strength.

Parameter frequency: - A normalized float from [0-1], with 0 representing the minimum frequency and 1 representing the maximum frequency of the vibration effect.

pub unsafe fn setModeVibrationWithAmplitudes_frequency( &self, positional_amplitudes: GCDualSenseAdaptiveTriggerPositionalAmplitudes, frequency: c_float, )

Sets the adaptive trigger to vibration mode. The amplitude of the effect can be set for each possible trigger position. The trigger arm will provide a degree of feedback based on the amplitude for a given position. The trigger arm will continue to strike against the trigger, providing a “sense of vibration”.

Parameter positionalAmplitudes: - Positional normalized floats from [0-1], with 0 representing the minimum effect strength (off entirely) and 1 representing the maximum effect strength.

Parameter frequency: - A normalized float from [0-1], with 0 representing the minimum frequency and 1 representing the maximum frequency of the vibration effect.

pub unsafe fn setModeOff(&self)

Sets the adaptive trigger to off mode. This turns off the adaptive trigger effect.

impl GCDualSenseAdaptiveTrigger

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = GCControllerButtonInput>

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

Setter for valueChangedHandler.

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.

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

Available on crate feature block2 only.

Setter for pressedChangedHandler.

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

Available on crate feature block2 only.

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

Available on crate feature block2 only.

Setter for touchedChangedHandler.

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

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

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

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

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 GCDualSenseAdaptiveTrigger

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GCControllerButtonInput> for GCDualSenseAdaptiveTrigger

fn as_ref(&self) -> &GCControllerButtonInput

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

impl AsRef<GCControllerElement> for GCDualSenseAdaptiveTrigger

fn as_ref(&self) -> &GCControllerElement

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

impl AsRef<GCDualSenseAdaptiveTrigger> for GCDualSenseAdaptiveTrigger

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GCDualSenseAdaptiveTrigger

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GCDualSenseAdaptiveTrigger

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<GCControllerButtonInput> for GCDualSenseAdaptiveTrigger

fn borrow(&self) -> &GCControllerButtonInput

Immutably borrows from an owned value.

impl Borrow<GCControllerElement> for GCDualSenseAdaptiveTrigger

fn borrow(&self) -> &GCControllerElement

Immutably borrows from an owned value.

impl Borrow<NSObject> for GCDualSenseAdaptiveTrigger

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GCDualSenseAdaptiveTrigger

const NAME: &'static str = "GCDualSenseAdaptiveTrigger"

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

type Super = GCControllerButtonInput

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for GCDualSenseAdaptiveTrigger

type Target = GCControllerButtonInput

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GCDualSenseAdaptiveTrigger

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 GCDualSenseAdaptiveTrigger

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GCDualSenseAdaptiveTrigger

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 GCDualSenseAdaptiveTrigger

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 GCDualSenseAdaptiveTrigger

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

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

impl DowncastTarget for GCDualSenseAdaptiveTrigger

impl Eq for GCDualSenseAdaptiveTrigger