NRSDKApiForUnity
>
Overview

Classes

struct  EyePoseData
 
struct  EyeProjectMatrixData
 
class  NRAnchor
 
class  NRCameraCapture
 
class  NRFrame
 
class  NRHMDPoseTracker
 
class  NRInput
 
class  NRRenderer
 
class  NRRgbCamera
 
class  NRSessionBehaviour
 
class  NRSessionConfig
 
class  NRSessionManager
 
class  NRTrackable
 
class  NRTrackableBehaviour
 
class  NRTrackableImage
 
class  NRTrackableManager
 
class  NRTrackablePlane
 
class  NRTrackingImageDatabase
 
struct  NRTrackingImageDatabaseEntry
 
class  NRVersionInfo
 
class  UpdateWorldOrigin
 

Enumerations

enum  ControllerHandEnum { Right = 0, Left = 1 }
 
enum  RaycastModeEnum { Gaze, Laser }
 
enum  ControllerVisualType { None = 0, NrealLight = 1, Phone = 2 }
 
enum  CameraImageFormat { YUV_420_888 = 1, RGB_888 = 2 }
 
enum  LostTrackingReason {
  NONE = 0, LostTrackingReason.INITIALIZING = 1, LostTrackingReason.EXCESSIVE_MOTION = 2, LostTrackingReason.INSUFFICIENT_FEATURES = 3,
  LostTrackingReason.RELOCALIZING = 4
}
 
enum  SessionState {
  SessionState.UnInitialize = 0, SessionState.Created, SessionState.Tracking, SessionState.Paused,
  SessionState.Stopped, SessionState.LostTracking
}
 
enum  TrackablePlaneType { TrackablePlaneType.HORIZONTAL = 0, TrackablePlaneType.VERTICAL = 1, TrackablePlaneType.INVALID = 2 }
 
enum  TrackablePlaneFindingMode { TrackablePlaneFindingMode.DISABLE = 0, TrackablePlaneFindingMode.HORIZONTAL = 1 }
 
enum  TrackableType { TrackableType.TRACKABLE_BASE = 0, TrackableType.TRACKABLE_PLANE = 1, TrackableType.TRACKABLE_IMAGE = 2 }
 
enum  TrackableImageFindingMode { TrackableImageFindingMode.DISABLE = 0, TrackableImageFindingMode.ENABLE = 1 }
 
enum  TrackingState { TrackingState.Tracking = 0, TrackingState.Paused = 1, TrackingState.Stopped = 2 }
 
enum  TrackingMode { TrackingMode.MODE_6DOF = 0, TrackingMode.MODE_3DOF = 1 }
 
enum  NRTrackableQueryFilter { NRTrackableQueryFilter.All, NRTrackableQueryFilter.New }
 

Enumeration Type Documentation

◆ CameraImageFormat

@ RGB Camera's image format.

◆ LostTrackingReason

The reason of HMD untracked.

Enumerator
INITIALIZING 

Initializing.

EXCESSIVE_MOTION 

Move too fast.

INSUFFICIENT_FEATURES 

Feature point deficiency.

RELOCALIZING 

Reposition.

◆ NRTrackableQueryFilter

A filter for trackable queries.

Enumerator
All 

Indicates available trackables.

New 

Indicates new trackables detected in the current NRSDK Frame.

◆ SessionState

enum NRKernal.SessionState
strong

Device Session State.

Enumerator
UnInitialize 

UnInitialize means the NRSDK has not been initialized.

Created 

Created means the NRSDK has been created.

Tracking 

TRACKING means the object is being tracked and its state is valid.

Paused 

PAUSED indicates that NRSDK has paused tracking, and the related data is not accurate.

Stopped 

STOPPED means that NRSDK has stopped tracking, and will never resume tracking.

LostTracking 

LostTracking means that NRSDK has lost tracking, and will never resume tracking.

◆ TrackableImageFindingMode

Trackable image's finding mode.

Enumerator
DISABLE 

Disable image tracking.

ENABLE 

Enable image tracking.

◆ TrackablePlaneFindingMode

Trackable plane's finding mode.

Enumerator
DISABLE 

Disable plane detection.

HORIZONTAL 

Enable plane detection.

◆ TrackablePlaneType

Trackable plane type.

Enumerator
HORIZONTAL 

HORIZONTAL trackable plane.

VERTICAL 

VERTICAL trackable plane.

INVALID 

INVALID trackable plane.

◆ TrackableType

Tracable object type.

Enumerator
TRACKABLE_BASE 

TRACKABLE_BASE means the base object of trackable.

TRACKABLE_PLANE 

TRACKABLE_PLANE means the trackable object is a plane.

TRACKABLE_IMAGE 

TRACKABLE_IMAGE means the trackable object is a tracking image.

◆ TrackingMode

enum NRKernal.TrackingMode
strong

Device Tracking State.

Enumerator
MODE_6DOF 

6Dof mode.

MODE_3DOF 

3Dof mode, only rotation.

◆ TrackingState

Device Tracking State.

Enumerator
Tracking 

TRACKING means the object is being tracked and its state is valid.

Paused 

PAUSED indicates that NRSDK has paused tracking, and the related data is not accurate.

Stopped 

STOPPED means that NRSDK has stopped tracking, and will never resume tracking.