Ground plane represents static trackable object placed on environment, to reposition head pose according to the relative pose between head and trackable object. More...

Inheritance diagram for Ximmerse.RhinoX.GroundPlane:

Public Types
enum	RecenterMode { RecenterMode.Automate = 0, RecenterMode.Scripting = 3 }
	Recenter behaviour mode. More...

Public Member Functions
void	SetUseDelayBack (bool value)

void	SetFixedDelay (bool value)

Static Public Member Functions
static void	ForceRecenter ()

Public Attributes
bool	DecoupleVIO = false
	if true, when ground recenters head, will decouple VIO motion logic. Default: false More...

UnityEvent	OnFirstRecenterEvent

Static Public Attributes
static Action< GroundPlane >	eventOnCreateGroundPlane
	Public static event : on create new dynamic target. More...

static Action< GroundPlane >	eventOnDeleteGroundPlane
	Public static event : on delete new dynamic target. More...

static Action< GroundPlane >	OnFirstRecenterAction

Properties
RecenterMode	recenterMode `[get, set]`
	Gets or sets the recenter mode. More...

PlanePlacement	Placement `[get, set]`
	Gets or sets the placement, this value indicates how the physics marker is placed, is it placed at ground or at wall. More...

int	GroupID `[get, set]`
	Ground plane's group ID, when using as seperate ground plane, use -1 by default. More...

float	RecenterInterval `[get, set]`
	Gets or sets the recenter interval. More...

float	MinTrackedDistance `[get, set]`
	Gets or sets the minimum tracking distance to allow recenter. 可以发生对齐的最小追踪距离. More...

float	MaxTrackedDistance `[get, set]`
	Gets or sets the max tracking distance to allow recenter. 可以发生对齐的最大追踪距离. More...

float	MaxRecenterAngularVelocity `[get, set]`
	The max angular velocity to allow recenter. More...

float	MinTrackedConfidence `[get, set]`
	The min tracked confidence to allow recenter. More...

float	MinErrorHeadDistance `[get, set]`
	The minimum error head distance. 对齐时候允许头部对齐动作的最小距离. More...

bool	DebugView `[get, set]`
	Activates or deactivate debug view. More...

float	MinErrorHeadDiffAngle `[get, set]`
	Gets or sets the minimum allow head diff angle to recenter. More...

float	MinTrackedAngle `[get, set]`
	Gets or sets the minimum tracked angle to repositional head pose. More...

Color	DrawColor `[get, set]`
	Gets or sets the color of the debug drawing. More...

static GroundPlane	CurrentGroundPlane `[get]`
	Current ground plane is the latest ground plane object that being used to recenter head. More...

Events
static Action< GroundPlane >	eventOnGroundPlanePosition
	Event : on ground plane is positioned. More...

Detailed Description

Ground plane represents static trackable object placed on environment, to reposition head pose according to the relative pose between head and trackable object.

Member Enumeration Documentation

◆ RecenterMode

enum Ximmerse.RhinoX.GroundPlane.RecenterMode

strong

Recenter behaviour mode.

Enumerator
Automate	Tries to recenter head everyframe, as long as the ground plane object is tracked. This is the default mode;
Scripting	Recenter by script call only. Call GroundPlane.ForceRecenter() .

Member Data Documentation

◆ DecoupleVIO

bool Ximmerse.RhinoX.GroundPlane.DecoupleVIO = false

if true, when ground recenters head, will decouple VIO motion logic. Default: false

◆ eventOnCreateGroundPlane

Action<GroundPlane> Ximmerse.RhinoX.GroundPlane.eventOnCreateGroundPlane

static

Public static event : on create new dynamic target.

◆ eventOnDeleteGroundPlane

Action<GroundPlane> Ximmerse.RhinoX.GroundPlane.eventOnDeleteGroundPlane

static

Public static event : on delete new dynamic target.

Property Documentation

◆ CurrentGroundPlane

GroundPlane Ximmerse.RhinoX.GroundPlane.CurrentGroundPlane

staticget

Current ground plane is the latest ground plane object that being used to recenter head.

The current ground plane.

◆ DebugView

bool Ximmerse.RhinoX.GroundPlane.DebugView

getset

Activates or deactivate debug view.

true if debug view; otherwise, false.

◆ DrawColor

Color Ximmerse.RhinoX.GroundPlane.DrawColor

getset

Gets or sets the color of the debug drawing.

The color of the draw.

◆ GroupID

int Ximmerse.RhinoX.GroundPlane.GroupID

getset

Ground plane's group ID, when using as seperate ground plane, use -1 by default.

◆ MaxRecenterAngularVelocity

float Ximmerse.RhinoX.GroundPlane.MaxRecenterAngularVelocity

getset

The max angular velocity to allow recenter.

◆ MaxTrackedDistance

float Ximmerse.RhinoX.GroundPlane.MaxTrackedDistance

getset

Gets or sets the max tracking distance to allow recenter. 可以发生对齐的最大追踪距离.

The max recenter distance.

◆ MinErrorHeadDiffAngle

float Ximmerse.RhinoX.GroundPlane.MinErrorHeadDiffAngle

getset

Gets or sets the minimum allow head diff angle to recenter.

The minimum error head diff angle.

◆ MinErrorHeadDistance

float Ximmerse.RhinoX.GroundPlane.MinErrorHeadDistance

getset

The minimum error head distance. 对齐时候允许头部对齐动作的最小距离.

The minimum error head span.

◆ MinTrackedAngle

float Ximmerse.RhinoX.GroundPlane.MinTrackedAngle

getset

Gets or sets the minimum tracked angle to repositional head pose.

The minimum tracked angle.

◆ MinTrackedConfidence

float Ximmerse.RhinoX.GroundPlane.MinTrackedConfidence

getset

The min tracked confidence to allow recenter.

◆ MinTrackedDistance

float Ximmerse.RhinoX.GroundPlane.MinTrackedDistance

getset

Gets or sets the minimum tracking distance to allow recenter. 可以发生对齐的最小追踪距离.

The minimum recenter distance.

◆ Placement

PlanePlacement Ximmerse.RhinoX.GroundPlane.Placement

getset

Gets or sets the placement, this value indicates how the physics marker is placed, is it placed at ground or at wall.

The placement.

◆ RecenterInterval

float Ximmerse.RhinoX.GroundPlane.RecenterInterval

getset

Gets or sets the recenter interval.

The recenter scanning interval.

◆ recenterMode

RecenterMode Ximmerse.RhinoX.GroundPlane.recenterMode

getset

Gets or sets the recenter mode.

The recenter mode.

Event Documentation

◆ eventOnGroundPlanePosition

Action<GroundPlane> Ximmerse.RhinoX.GroundPlane.eventOnGroundPlanePosition

static

Event : on ground plane is positioned.

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

GroundPlane.cs

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Events

Detailed Description

Member Enumeration Documentation

◆ RecenterMode

Member Data Documentation

◆ DecoupleVIO

◆ eventOnCreateGroundPlane

◆ eventOnDeleteGroundPlane

Property Documentation

◆ CurrentGroundPlane

◆ DebugView

◆ DrawColor

◆ GroupID

◆ MaxRecenterAngularVelocity

◆ MaxTrackedDistance

◆ MinErrorHeadDiffAngle

◆ MinErrorHeadDistance

◆ MinTrackedAngle

◆ MinTrackedConfidence

◆ MinTrackedDistance

◆ Placement

◆ RecenterInterval

◆ recenterMode

Event Documentation

◆ eventOnGroundPlanePosition