Rhinox Unity SDK
Classes | Static Public Member Functions | List of all members
Ximmerse.RhinoX.RXInput Class Reference

RhinoX helmet input. More...

Classes

struct  ButtonRuntimeState
 

Static Public Member Functions

static bool IsButton (RhinoXButton button=RhinoXButton.ConfirmButton, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Is player pressing the RhinoX button ? More...
 
static bool IsButtonDown (RhinoXButton button=RhinoXButton.ConfirmButton, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 is player pressing down the RhinoX button ? More...
 
static bool IsButtonLongHeldDown (RhinoXButton button=RhinoXButton.ConfirmButton, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 is player held down the RhinoX button for a relative long time ? More...
 
static bool IsButtonUp (RhinoXButton button=RhinoXButton.ConfirmButton, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 is player pressing up the RhinoX button ? More...
 
static bool IsButtonTap (RhinoXButton button=RhinoXButton.ConfirmButton, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Is player tapping on the RhinoX button ? For button = RhinoXButton.ConfirmButton, index is ignored. More...
 
static bool IsButtonDoubleTap (RhinoXButton button=RhinoXButton.ConfirmButton, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Is player double tapping on the RhinoX button ? More...
 
static float GetTriggerValue (ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Gets the linear trigger value of the controller More...
 
static int GetPairedControllerCount ()
 Gets how many controller is paired. More...
 
static XDeviceInfo [] GetPairedControllerInfos ()
 Gets the paired controller infos. Attention : this method allocate runtime memory. More...
 
static int GetConnectedControllerCount ()
 Gets the connected controller count. More...
 
static XDeviceInfo [] GetConnectedControllerInfos ()
 Gets the connected controller infos. Attention : this method allocate runtime memory. More...
 
static bool GetTouchPadPointer (ref Vector2 TouchPadPointer, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Gets the touch pad pointer, represents finger touch pointer on the touch pad. More...
 
static bool GetTouchPadPointer (ref TouchPadButtonDirection Direction, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Gets the touch pad pointer direction, represents finger touch pointer on the touch pad. More...
 
static Quaternion GetControllerRotation (ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Gets the RhinoX standard controller built-in gyroscope output rotation. More...
 
static Vector3 GetControllerPosition (ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 
static Vector3 GetControllerAcceleration (ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Gets the controller acceleration output. More...
 
static I_TouchPadFingerState GetTouchPadState (ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Gets the state of the touch pad. More...
 
static void Viberate (float Strength, float VibrateTime, ControllerIndex index=ControllerIndex.Controller_Right_Controller)
 Vibrate the controller at the index. Strength should be 0-1. VibrateTime is the seconds you want to vibrate. More...
 
static bool IsTouchPadButton (TouchPadButtonDirection touchPadButton, ControllerIndex controllerIndex=ControllerIndex.Controller_Right_Controller)
 Check if the touch pad's button direction is currently pressing down ? More...
 
static bool IsTouchPadButtonDown (TouchPadButtonDirection touchPadButton, ControllerIndex controllerIndex=ControllerIndex.Controller_Right_Controller)
 Check if the touch pad's button direction is at pressing down frame ? More...
 
static bool IsTouchPadButtonUp (TouchPadButtonDirection touchPadButton, ControllerIndex controllerIndex=ControllerIndex.Controller_Right_Controller)
 Check if the touch pad's button direction is at release up frame ? More...
 
static bool IsTouchPadButtonTap (TouchPadButtonDirection touchPadButton, ControllerIndex controllerIndex=ControllerIndex.Controller_Right_Controller)
 Check if the touch pad's button direction currently being tap? More...
 
static bool IsTouchPadButtonDoubleTap (TouchPadButtonDirection touchPadButton, ControllerIndex controllerIndex=ControllerIndex.Controller_Right_Controller)
 Check if the touch pad's button direction currently being double tap? More...
 

Detailed Description

RhinoX helmet input.

Member Function Documentation

◆ GetConnectedControllerCount()

static int Ximmerse.RhinoX.RXInput.GetConnectedControllerCount ( )
inlinestatic

Gets the connected controller count.

Returns
The connected controller count.

◆ GetConnectedControllerInfos()

static XDeviceInfo [] Ximmerse.RhinoX.RXInput.GetConnectedControllerInfos ( )
inlinestatic

Gets the connected controller infos. Attention : this method allocate runtime memory.

Returns
The connected controller infos.

◆ GetControllerAcceleration()

static Vector3 Ximmerse.RhinoX.RXInput.GetControllerAcceleration ( ControllerIndex  index = ControllerIndex.Controller_Right_Controller)
inlinestatic

Gets the controller acceleration output.

Returns
The controller acceleration.
Parameters
indexIndex.

◆ GetControllerRotation()

static Quaternion Ximmerse.RhinoX.RXInput.GetControllerRotation ( ControllerIndex  index = ControllerIndex.Controller_Right_Controller)
inlinestatic

Gets the RhinoX standard controller built-in gyroscope output rotation.

Returns
true, if controller rotation was gotten, false otherwise.

◆ GetPairedControllerCount()

static int Ximmerse.RhinoX.RXInput.GetPairedControllerCount ( )
inlinestatic

Gets how many controller is paired.

Returns
The paired controller.

◆ GetPairedControllerInfos()

static XDeviceInfo [] Ximmerse.RhinoX.RXInput.GetPairedControllerInfos ( )
inlinestatic

Gets the paired controller infos. Attention : this method allocate runtime memory.

Returns
The paired controller infos.

◆ GetTouchPadPointer() [1/2]

static bool Ximmerse.RhinoX.RXInput.GetTouchPadPointer ( ref Vector2  TouchPadPointer,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Gets the touch pad pointer, represents finger touch pointer on the touch pad.

Returns
true, if touch pad pointer was gotten, false otherwise.
Parameters
TouchPadPointerTouch pad pointer.
indexIndex.

◆ GetTouchPadPointer() [2/2]

static bool Ximmerse.RhinoX.RXInput.GetTouchPadPointer ( ref TouchPadButtonDirection  Direction,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Gets the touch pad pointer direction, represents finger touch pointer on the touch pad.

Returns
true, if touch pad pointer was gotten, false otherwise.
Parameters
DirectionTouch pad direction.
indexIndex.

◆ GetTouchPadState()

static I_TouchPadFingerState Ximmerse.RhinoX.RXInput.GetTouchPadState ( ControllerIndex  index = ControllerIndex.Controller_Right_Controller)
inlinestatic

Gets the state of the touch pad.

Returns
The touch pad state.
Parameters
indexIndex.

◆ GetTriggerValue()

static float Ximmerse.RhinoX.RXInput.GetTriggerValue ( ControllerIndex  index = ControllerIndex.Controller_Right_Controller)
inlinestatic

Gets the linear trigger value of the controller

Parameters
index
Returns

◆ IsButton()

static bool Ximmerse.RhinoX.RXInput.IsButton ( RhinoXButton  button = RhinoXButton.ConfirmButton,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Is player pressing the RhinoX button ?

Returns
true, if confirm key was ised, false otherwise.

◆ IsButtonDoubleTap()

static bool Ximmerse.RhinoX.RXInput.IsButtonDoubleTap ( RhinoXButton  button = RhinoXButton.ConfirmButton,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Is player double tapping on the RhinoX button ?

Returns
true, if button tap was ised, false otherwise.
Parameters
buttonButton.

◆ IsButtonDown()

static bool Ximmerse.RhinoX.RXInput.IsButtonDown ( RhinoXButton  button = RhinoXButton.ConfirmButton,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

is player pressing down the RhinoX button ?

Returns
true, if confirm key down was ised, false otherwise.

◆ IsButtonLongHeldDown()

static bool Ximmerse.RhinoX.RXInput.IsButtonLongHeldDown ( RhinoXButton  button = RhinoXButton.ConfirmButton,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

is player held down the RhinoX button for a relative long time ?

Returns
true, if confirm key down was ised, false otherwise.

◆ IsButtonTap()

static bool Ximmerse.RhinoX.RXInput.IsButtonTap ( RhinoXButton  button = RhinoXButton.ConfirmButton,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Is player tapping on the RhinoX button ? For button = RhinoXButton.ConfirmButton, index is ignored.

Returns
true, if button tap was ised, false otherwise.
Parameters
buttonButton.

◆ IsButtonUp()

static bool Ximmerse.RhinoX.RXInput.IsButtonUp ( RhinoXButton  button = RhinoXButton.ConfirmButton,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

is player pressing up the RhinoX button ?

Returns
true, if button up was ised, false otherwise.
Parameters
buttonButton.
indexController Index.

◆ IsTouchPadButton()

static bool Ximmerse.RhinoX.RXInput.IsTouchPadButton ( TouchPadButtonDirection  touchPadButton,
ControllerIndex  controllerIndex = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Check if the touch pad's button direction is currently pressing down ?

Parameters
touchPadButton
Returns

◆ IsTouchPadButtonDoubleTap()

static bool Ximmerse.RhinoX.RXInput.IsTouchPadButtonDoubleTap ( TouchPadButtonDirection  touchPadButton,
ControllerIndex  controllerIndex = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Check if the touch pad's button direction currently being double tap?

Parameters
touchPadButton
Returns

◆ IsTouchPadButtonDown()

static bool Ximmerse.RhinoX.RXInput.IsTouchPadButtonDown ( TouchPadButtonDirection  touchPadButton,
ControllerIndex  controllerIndex = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Check if the touch pad's button direction is at pressing down frame ?

Parameters
touchPadButton
Returns

◆ IsTouchPadButtonTap()

static bool Ximmerse.RhinoX.RXInput.IsTouchPadButtonTap ( TouchPadButtonDirection  touchPadButton,
ControllerIndex  controllerIndex = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Check if the touch pad's button direction currently being tap?

Parameters
touchPadButton
Returns

◆ IsTouchPadButtonUp()

static bool Ximmerse.RhinoX.RXInput.IsTouchPadButtonUp ( TouchPadButtonDirection  touchPadButton,
ControllerIndex  controllerIndex = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Check if the touch pad's button direction is at release up frame ?

Parameters
touchPadButton
Returns

◆ Viberate()

static void Ximmerse.RhinoX.RXInput.Viberate ( float  Strength,
float  VibrateTime,
ControllerIndex  index = ControllerIndex.Controller_Right_Controller 
)
inlinestatic

Vibrate the controller at the index. Strength should be 0-1. VibrateTime is the seconds you want to vibrate.

Parameters
Strength
VibrateTime
index

The documentation for this class was generated from the following file: