Rhinox Unity SDK
Classes | Enumerations
Ximmerse.RhinoX Namespace Reference

Classes

class  ARCamera
 AR camera is the script that represents virtual camera in AR world. Developer may get the position/rotation of current head transform. More...
 
class  DynamicTarget
 Default trackable behaviour, updates trackable object's transform at the head space per-frame. More...
 
class  GroundPlane
 Ground plane represents static trackable object placed on environment, to reposition head pose according to the relative pose between head and trackable object. More...
 
interface  I_ButtonEventTrigger
 Interface : Button event trigger. More...
 
interface  I_ControllerUpdateDelegate
 
struct  MarkerConfigInfo
 Marker config info : a single marker object's config info from JSON.
 
class  ObjectTracking
 Object tracking : access tag tracking interface. More...
 
class  ObjectTrackingProfile
 
class  PositionPrediction
 Position prediction
 
class  RhinoXGlobalSetting
 Rhino X SDK global setting. Should be placed in folder: Assets/Plugins/RhinoX/Resources. More...
 
class  RhinoXSystem
 RhinoX system : access system software and hardware information. More...
 
class  RotationPrediction
 Basic Rotation prediction.
 
class  RxButtonEvent
 
class  RXButtonEventTrigger
 RhinoX button input event trigger. More...
 
class  RXController
 High level SDK script for developers to access controller data and event, e.g. buttons, gyroscopes, finger point over touch-pad. More...
 
class  RxEventEntry
 
class  RXEventSystem
 RhinoX event system, should be singleton instance, driver class of RhinoX input event system. Note: RXEventSystem need to be the only event system, if your scene has Unity's built in EventSystem instane, RXEventSystem will remove it when starts. More...
 
class  RXInput
 RhinoX helmet input. More...
 
class  RXInputModule
 RhinoX controller module, public interface to ximmerse controller input event system. More...
 
struct  SDKVersion
 SDK version. More...
 
class  TrackableBehaviour
 The basic abstract class of trackable beahviour . DynamicTarget and GroundPlane inherits from this script. More...
 
class  TrackableIdentity
 Trackable object identity. Constraint by an integral trackable ID , represents a trackable object in real world. More...
 
class  TrackingItem
 Tracking item. More...
 
class  VisiblityChangeEvent
 

Enumerations

enum  ControllerIndex { ControllerIndex.Controller_Left_Controller = 0, ControllerIndex.Controller_Right_Controller = 1, ControllerIndex.Controller03_Preserved = 2, ControllerIndex.Controller04_Preserved = 3 }
 Controller index. More...
 
enum  ControllerRotationFusionMode { ControllerRotationFusionMode.Semi = 0, ControllerRotationFusionMode.FullGyroscope, ControllerRotationFusionMode.None }
 Controller rotation fusion mode. More...
 
enum  ControllerTrackingMode { ControllerTrackingMode.DOF_6 = 0, ControllerTrackingMode.DOF_3 = 1 }
 How the controller is being tracked More...
 
enum  LostTrackingBehaviour { LostTrackingBehaviour.Stay = 0, LostTrackingBehaviour.FollowHead = 1 }
 定义当丢失跟踪的时候, 应该如何处理此 Dynamic target. More...
 
enum  PlanePlacement { Ground = 0, Wall = 1 }
 Plane placement type : placed at ground (horizontally) or placed at wall (vertically). More...
 
enum  RhinoXButton {
  RhinoXButton.ConfirmButton = KeyCode.Return, RhinoXButton.ControllerTrigger = 0x40000, RhinoXButton.ControllerTouchPadButton = 0x0004, RhinoXButton.App = 0x0010,
  RhinoXButton.Home = 0x08
}
 Enumeration defines all RhinoX buttons. Includes side-bar button on RhinoX and standard bluetooth controller. More...
 
enum  TouchPadButtonDirection {
  Up = 0, Right, Bottom, Left,
  Center
}
 Touch pad button direction. More...
 
enum  FingerDirection { Up = 1, Right = 2, Down = 4, Left = 8 }
 
enum  GroundPlaneAlgorithm { GroundPlaneAlgorithm.Fusion = 0, GroundPlaneAlgorithm.Legacy = 1 }
 定义 Ground plane 定位的算法版本 More...
 
enum  ControllerButtonCode { Trigger = 0x40000, TouchPadButton = 0x0004, App = 0x0010, Home = 0x08 }
 RhinoX controller button enumeration. More...
 
enum  XDeviceConnectionState { XDeviceConnectionState.Disconnected = 0, XDeviceConnectionState.Scanning = 1, XDeviceConnectionState.Connecting = 2, XDeviceConnectionState.Connected = 3 }
 

Enumeration Type Documentation

◆ ControllerButtonCode

RhinoX controller button enumeration.

Ximmerse controller button code.

◆ ControllerIndex

Controller index.

Enumerator
Controller_Left_Controller 

The controller - left controller.

Controller_Right_Controller 

The controller - right controller.

Controller03_Preserved 

The controller 03 (preserved).

Controller04_Preserved 

The controller 04 (preserved).

◆ ControllerRotationFusionMode

Controller rotation fusion mode.

Enumerator
Semi 

The semi mode, when tracking output in poor quality , use IMU rotation instead.

FullGyroscope 

use controller IMU to override tracking rotation.

None 

No fusion, use tracking rotation only .

◆ ControllerTrackingMode

How the controller is being tracked

Enumerator
DOF_6 

6Dof tracking, rotation and position of controller will be update

DOF_3 

3Dof tracking, only rotation of controller will be update, position update with ARCamera + offset

◆ GroundPlaneAlgorithm

定义 Ground plane 定位的算法版本

Enumerator
Fusion 

新的fusion库中的版本

Legacy 

旧的 CSharp 实现版本

◆ LostTrackingBehaviour

定义当丢失跟踪的时候, 应该如何处理此 Dynamic target.

Enumerator
Stay 

Stay at the last visible place when lost tracking. 如果丢失跟踪, 则 dynamic target 停留在原地。

FollowHead 

Follow AR camera's movement, when lost tracking. 如果丢失跟踪, 则 dynamic target 会以最后一帧相对于头部的姿态, 跟随头部运动。

◆ PlanePlacement

Plane placement type : placed at ground (horizontally) or placed at wall (vertically).

◆ RhinoXButton

Enumeration defines all RhinoX buttons. Includes side-bar button on RhinoX and standard bluetooth controller.

Enumerator
ConfirmButton 

The confirm button on RhinoX side bar.

ControllerTrigger 

The trigger button on RhinoX standard controller. This enumeration item is equated to ControllerButtonCode.Trigger

ControllerTouchPadButton 

The touchpad button on RhinoX standard controller. This enumeration item is equated to ControllerButtonCode.TouchPad

App 

The app button on RhinoX standard controller. This enumeration item is equated to ControllerButtonCode.App

Home 

The home button on RhinoX standard controller. This enumeration item is equated to ControllerButtonCode.Home

◆ TouchPadButtonDirection

Touch pad button direction.

◆ XDeviceConnectionState

Enumerator
Disconnected 

已断开连接

Scanning 

搜索中

Connecting 

连接中

Connected 

已连接