Meta Developers

The primary purpose of this type is to encapsulate input mappings allowing inputs from various controller types to be interpreted appropriately. Descendant types are thus expected to use their abstract method overrides (such as of ConfigureButtonMap) to initialize input mappings to reasonable defaults for the control scheme being implemented.

Fields

Controller controllerType[Get]

The controller type (gamepad, Oculus Touch, etc.) of the physical controller represented by this instance.

This value is typically set by a descendant type of OVRControllerBase during construction.

VirtualButtonMap buttonMap[Get]

The VirtualButtonMap characterizing how physical button inputs should be mapped to RawButton states as appropriate to this control scheme.

This mapping should be initialized during construction by the implementation of ConfigureButtonMap.

VirtualTouchMap touchMap[Get]

The VirtualTouchMap characterizing how physical touch inputs should be mapped to RawTouch states as appropriate to this control scheme.

This mapping should be initialized during construction by the implementation of ConfigureTouchMap.

VirtualNearTouchMap nearTouchMap[Get]

The VirtualNearTouchMap characterizing how physical proximity inputs should be mapped to RawNearTouch states as appropriate to this control scheme.

This mapping should be initialized during construction by the implementation of ConfigureNearTouchMap.

VirtualAxis1DMap axis1DMap[Get]

The VirtualAxis1DMap characterizing how physical single-axis inputs should be mapped to RawAxis1D states as appropriate to this control scheme.

This mapping should be initialized during construction by the implementation of ConfigureAxis1DMap.

VirtualAxis2DMap axis2DMap[Get]

The VirtualAxis2DMap characterizing how physical two-axis inputs should be mapped to RawAxis2D states as appropriate to this control scheme.

This mapping should be initialized during construction by the implementation of ConfigureAxis2DMap.

OVRPlugin.ControllerState6 previousState[Get]

The previous state (prior to the most recent Update of the this controller.

This data can be used by polling logic to determine whether state has changed. The data is updated automatically as part of the instance's Update.

OVRPlugin.ControllerState6 currentState[Get]

The current state (as of the most recent Update of the this controller.

This data can be used directly to observe the current state or compared with previousState to determine whether state has changed. The data is updated automatically as part of the instance's Update.

bool shouldApplyDeadzone[Get]

Determines whether a "dead zone" should be applied to suppress small values of one- and two-axis inputs.

It is possible to set this value manually; however, there is internal logic which can set this value on its own under certain circumstances, in which case the manually-set value may be overridden without warning.

Member Functions

OVRControllerBase ( )

Basic constructor responsible for initializing input mappings.

This is done by invoking the configuration methods (ConfigureButtonMap, ConfigureTouchMap, etc.), which descendant types should use to appropriately initialize the respective input mappings (buttonMap, touchMap, etc.).

virtual Controller Update ( )

Updates this instance by reading inputs from the underlying system, reinterpreting them as specified by the input maps (buttonMap, touchMap, etc.), and updating the information in currentState and previousState.

Returns

An enum bit mask indicating whether a controller of controllerType is currently connected

virtual void SetControllerVibration

( float frequency,

float amplitude )

Sets the vibration of the physical controller represented by this instance.

Parameters

frequency

The frequency of the desired vibration

amplitude

The amplitude of the desired vibration

virtual void SetControllerLocalizedVibration

( HapticsLocation hapticsLocationMask,

float frequency,

float amplitude )

Sets the localized vibration of the physical controller represented by this instance.

Parameters

hapticsLocationMask

A mask indicating the locations to which this vibration should apply

frequency

The frequency of the desired vibration

amplitude

The amplitude of the desired vibration

virtual void SetControllerHapticsAmplitudeEnvelope

( HapticsAmplitudeEnvelopeVibration hapticsVibration )

Sets the HapticsAmplitudeEnvelopeVibration for the physical controller represented by this instance.

Parameters

hapticsVibration

The desired haptics amplitude envelope vibration

virtual int SetControllerHapticsPcm

( HapticsPcmVibration hapticsVibration )

Sets the HapticsPcmVibration for the physical controller represented by this instance.

Parameters

hapticsVibration

The desired PCM vibration to be sent to the system

Returns

The number of samples consumed by the resulting native invocation

virtual float GetControllerSampleRateHz ( )

Retrieves the hardware sampling rate of the physical controller represented by this instance.

Returns

The sampling rate, in hertz

virtual byte GetBatteryPercentRemaining ( )

Retrieves the current estimated battery power remaining for the current control scheme.

Returns

The estimated battery power remaining as a percentage of the maximum

abstract void ConfigureButtonMap ( )

Initializes the buttonMap to appropriate default values for the control scheme encapsulated in this instance.