AR camera is the script that represents virtual camera in AR world. Developer may get the position/rotation of current head transform. More...

Inheritance diagram for Ximmerse.RhinoX.ARCamera:

Public Member Functions
bool	RecenterTracking (bool YawOnly=true)
	Recenters the tracking. More...

bool	SetObjecTrackingProfile (ObjectTrackingProfile newProfile)
	Changes object tracking profile runtime, the previous tracking profile, if not null, will be unloaded. If object tracking not enabled at the time when called, return false, and tracking profile property not change. If change tracking profile successfully, return true, and tracking profile property will be changed. More...

bool	LoadTrackingFile (string jsonFilePath)
	Loads a json file from file path. More...

void	SetFov (float hFov, float vFov)
	Sets the horizontal and vertical fov. More...

void	ResetFov ()
	Resets the horizontal and vertical fov. Default value : hFov = 77.099 , hFov = 77.099 More...

Ray	GetReticleRay ()
	Gets a ray represents the reticle raycaster's raycasting direction. More...

Static Public Member Functions
static void	SetCullingMask (LayerMask layermask)
	Sets the left and right eye's culling mask. More...

static void	SetOverlayCullingMask (LayerMask layermask)
	Sets the left and right Overlay eye's culling mask. More...

Public Attributes
Transform	trackingAnchor
	Tracking anchor : Center, left, right. More...

Properties
static ARCamera	Instance `[get]`

float	EyePitch `[get, set]`
	Gets or sets the eye pitch, this is eye's pitch euler angle around local X axis. More...

float	InterPupilDistance `[get, set]`
	IPD : inter pupil distance. Most common value is 0.062 (62mm), developer may customize this value . More...

bool	TrackPosition `[get, set]`
	Should track position ? If set to use, position of head would not be updated by SDK. More...

bool	TrackRotation `[get, set]`
	Should track rotation ? If set to use, rotation of head would not be updated by SDK. More...

bool	IsARBegan `[get]`
	Returns true if internal AR engine's began. AR begin means: More...

Transform	LeftEyeNode `[get]`
	Gets the left eye transform. More...

Transform	RightEyeNode `[get]`
	Gets the right eye transform. More...

Transform	LeftOverlayEyeNode `[get]`
	Gets the left overlay eye transform. More...

Transform	RightOverlayEyeNode `[get]`
	Gets the right overlay eye transform. More...

Pose	HeadPose `[get]`
	Head pose (non predict) More...

bool	IsObjectTrackingEnabled `[get]`
	Is the object tracking functions up and running ? More...

ObjectTrackingProfile	TrackingProfile `[get]`
	Gets the currently loaded tag tracking profile. Sets this variable will cause the previous profile been unloaded, then the new one will be loaded. More...

bool	DebugView `[get, set]`
	Gets or sets a value indicating whether this T:Ximmerse.RhinoX.ARCamera debug view. More...

float	hFov `[get]`
	Gets the horizontal field of view. By default this value = 77.091. More...

float	vFov `[get]`
	Gets the vertical field of view. By default this value = 77.091. More...

bool	EnableReticle `[get, set]`
	Should enable reticle ? If true, reticle is rendered, and reticle raycaster is enable. If false, rectile is not rendered and reticle raycaster is disable. More...

Texture2D	ReticleImage `[get, set]`
	Gets or sets the reticle image. More...

LayerMask	ReticleInteractMask `[get, set]`
	Gets or sets the Reticle raycaster's interactable game object culling mask. More...

Events
static System.Action< Camera, Camera >	OnCreateStereoCameras = null
	Event is fired after stereo eyes are created. Developers can add post effect scripts on this event. First camera parameter = left eye camera; Second camera parameter = right eye camera; More...

static System.Action	OnRhinoXSDKInitialized = null
	Event is fired after the RhinoX SDK is initialized. More...

Detailed Description

AR camera is the script that represents virtual camera in AR world. Developer may get the position/rotation of current head transform.

AR camera : rendering

Member Function Documentation

◆ GetReticleRay()

Ray Ximmerse.RhinoX.ARCamera.GetReticleRay ( )

inline

Gets a ray represents the reticle raycaster's raycasting direction.

Returns: The reticle ray.

◆ LoadTrackingFile()

bool Ximmerse.RhinoX.ARCamera.LoadTrackingFile ( string jsonFilePath )

inline

Loads a json file from file path.

Parameters

jsonFilePath

Returns

◆ RecenterTracking()

bool Ximmerse.RhinoX.ARCamera.RecenterTracking ( bool YawOnly = true )

inline

Recenters the tracking.

Returns: true, if tracking was recentered, false otherwise.

◆ ResetFov()

void Ximmerse.RhinoX.ARCamera.ResetFov ( )

inline

Resets the horizontal and vertical fov. Default value : hFov = 77.099 , hFov = 77.099

◆ SetCullingMask()

static void Ximmerse.RhinoX.ARCamera.SetCullingMask ( LayerMask layermask )

inlinestatic

Sets the left and right eye's culling mask.

◆ SetFov()

void Ximmerse.RhinoX.ARCamera.SetFov	(	float	hFov,
		float	vFov
	)

inline

Sets the horizontal and vertical fov.

Returns: The fov.

Parameters

hFov	H fov.
vFov	V fov.

◆ SetObjecTrackingProfile()

bool Ximmerse.RhinoX.ARCamera.SetObjecTrackingProfile ( ObjectTrackingProfile newProfile )

inline

Changes object tracking profile runtime, the previous tracking profile, if not null, will be unloaded. If object tracking not enabled at the time when called, return false, and tracking profile property not change. If change tracking profile successfully, return true, and tracking profile property will be changed.

Returns: true, if objec tracking profile was set, false otherwise.

◆ SetOverlayCullingMask()

static void Ximmerse.RhinoX.ARCamera.SetOverlayCullingMask ( LayerMask layermask )

inlinestatic

Sets the left and right Overlay eye's culling mask.

Member Data Documentation

◆ trackingAnchor

Transform Ximmerse.RhinoX.ARCamera.trackingAnchor

Tracking anchor : Center, left, right.

Property Documentation

◆ DebugView

bool Ximmerse.RhinoX.ARCamera.DebugView

getset

Gets or sets a value indicating whether this T:Ximmerse.RhinoX.ARCamera debug view.

true if debug view; otherwise, false.

◆ EnableReticle

bool Ximmerse.RhinoX.ARCamera.EnableReticle

getset

Should enable reticle ? If true, reticle is rendered, and reticle raycaster is enable. If false, rectile is not rendered and reticle raycaster is disable.

true if render reticle; otherwise, false.

◆ EyePitch

float Ximmerse.RhinoX.ARCamera.EyePitch

getset

Gets or sets the eye pitch, this is eye's pitch euler angle around local X axis.

The eye pitch.

◆ HeadPose

Pose Ximmerse.RhinoX.ARCamera.HeadPose

get

Head pose (non predict)

Gets the current VIO output head pose.

The predict head pose.

◆ hFov

float Ximmerse.RhinoX.ARCamera.hFov

get

Gets the horizontal field of view. By default this value = 77.091.

The h fov.

◆ InterPupilDistance

float Ximmerse.RhinoX.ARCamera.InterPupilDistance

getset

IPD : inter pupil distance. Most common value is 0.062 (62mm), developer may customize this value .

The inter pupil distance.

◆ IsARBegan

bool Ximmerse.RhinoX.ARCamera.IsARBegan

get

Returns true if internal AR engine's began. AR begin means:

Head tracking engine starts.
Stereo eye rendering and time wrap thread starts.
Object tracking engine starts.

true if is ARB egan; otherwise, false.

◆ IsObjectTrackingEnabled

bool Ximmerse.RhinoX.ARCamera.IsObjectTrackingEnabled

get

Is the object tracking functions up and running ?

true if is object tracking enabled; otherwise, false.

◆ LeftEyeNode

Transform Ximmerse.RhinoX.ARCamera.LeftEyeNode

get

Gets the left eye transform.

The left eye node.

◆ LeftOverlayEyeNode

Transform Ximmerse.RhinoX.ARCamera.LeftOverlayEyeNode

get

Gets the left overlay eye transform.

The left eye node.

◆ ReticleImage

Texture2D Ximmerse.RhinoX.ARCamera.ReticleImage

getset

Gets or sets the reticle image.

The reticle image.

◆ ReticleInteractMask

LayerMask Ximmerse.RhinoX.ARCamera.ReticleInteractMask

getset

Gets or sets the Reticle raycaster's interactable game object culling mask.

The interact object mask.

◆ RightEyeNode

Transform Ximmerse.RhinoX.ARCamera.RightEyeNode

get

Gets the right eye transform.

The right eye node.

◆ RightOverlayEyeNode

Transform Ximmerse.RhinoX.ARCamera.RightOverlayEyeNode

get

Gets the right overlay eye transform.

The right eye node.

◆ TrackingProfile

ObjectTrackingProfile Ximmerse.RhinoX.ARCamera.TrackingProfile

get

Gets the currently loaded tag tracking profile. Sets this variable will cause the previous profile been unloaded, then the new one will be loaded.

The tracking profile.

◆ TrackPosition

bool Ximmerse.RhinoX.ARCamera.TrackPosition

getset

Should track position ? If set to use, position of head would not be updated by SDK.

true if shoud track position; otherwise, false.

◆ TrackRotation

bool Ximmerse.RhinoX.ARCamera.TrackRotation

getset

Should track rotation ? If set to use, rotation of head would not be updated by SDK.

true if shoud track position; otherwise, false.

◆ vFov

float Ximmerse.RhinoX.ARCamera.vFov

get

Gets the vertical field of view. By default this value = 77.091.

The v fov.

Event Documentation

◆ OnCreateStereoCameras

System.Action<Camera, Camera> Ximmerse.RhinoX.ARCamera.OnCreateStereoCameras = null

static

Event is fired after stereo eyes are created. Developers can add post effect scripts on this event. First camera parameter = left eye camera; Second camera parameter = right eye camera;

◆ OnRhinoXSDKInitialized

System.Action Ximmerse.RhinoX.ARCamera.OnRhinoXSDKInitialized = null

static

Event is fired after the RhinoX SDK is initialized.

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

ARCamera.cs
ARCamera_Rendering.cs
ARCamera_Reticle.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ GetReticleRay()

◆ LoadTrackingFile()

◆ RecenterTracking()

◆ ResetFov()

◆ SetCullingMask()

◆ SetFov()

◆ SetObjecTrackingProfile()

◆ SetOverlayCullingMask()

Member Data Documentation

◆ trackingAnchor

Property Documentation

◆ DebugView

◆ EnableReticle

◆ EyePitch

◆ HeadPose

◆ hFov

◆ InterPupilDistance

◆ IsARBegan

◆ IsObjectTrackingEnabled

◆ LeftEyeNode

◆ LeftOverlayEyeNode

◆ ReticleImage

◆ ReticleInteractMask

◆ RightEyeNode

◆ RightOverlayEyeNode

◆ TrackingProfile

◆ TrackPosition

◆ TrackRotation

◆ vFov

Event Documentation

◆ OnCreateStereoCameras

◆ OnRhinoXSDKInitialized