Skip to content

Enums & Types

ForwardAxis

Silhouette data generation settings. Maps to FTModelConfig for C++ interop. Viewpoint coverage preset. Controls which angles are included in model generation. Reference direction for horizontal viewpoint filtering. Y directions are not valid for azimuth filtering (elevation axis). Object-local axis direction. Used for both up axis and forward axis configuration.

Value Description
PositiveX = 0
NegativeX = 1
PositiveY = 2
NegativeY = 3
PositiveZ = 4
NegativeZ = 5

ImageSource

Camera input source for XRTrackerManager.

Value Description
Native = 0 Native webcam capture. A calibration file gives the best accuracy, and without one the camera intrinsics are estimated from the field of view.
Injected = 1 Unity feeds frames (AR Foundation). No calibration file needed.
RealSense = 2 Intel RealSense SDK capture (color + depth). No calibration file needed.
Sequence = 3 Recorded image sequence. C++ reads PNGs directly — no C# texture overhead.

InitialPoseSource

Determines how the initial pose is computed for detection.

Value Description
ScenePosition Use the object's current position in the scene. The pose is calculated relative to the main camera at startup.
Viewpoint Use a specified viewpoint transform. The object's pose is calculated relative to the viewpoint.

LicenseStatus

License validation status. Mirrors C++ LicenseStatus.

Value Description
NotSet = 0
Valid = 1
Expired = 2
InvalidSignature = 3
MachineIdMismatch = 4
AppIdMismatch = 5
FormatError = 6

LicenseTier

License tiers. Mirrors C++ LicenseTier (OEM maps to Commercial on the native side).

Value Description
None = 0 No license loaded
Free = 1 Deprecated. Legacy Free tier.
Trial = 2 Deprecated. Legacy Trial tier.
Developer = 3 Free Developer license (1-year, renewable)
Commercial = 4 Paid Commercial license (yearly, node-locked)

PartPresence

The presence reading of a part in assembly mode, read from TrackedBody.Presence. A part is judged only while the camera is near its check view and still, and only from the evidence of a whole hold.

Value Description
Unknown = 0 The part is not judged. It has no check view, the camera is not near it or not still, the parent is not tracked, the hold has not lasted long enough yet, or the evidence of the hold is mixed.
Present = 1 Near the check view and with the camera still, the part read present on most of the hold.
Absent = 2 Near the check view and with the camera still, the part read absent on most of the hold.

RealSenseColorResolution

RealSense color camera resolution options.

Value Description
Resolution_640x480_60fps = 0 640x480 @ 60fps
Resolution_960x540_60fps = 1 960x540 @ 60fps (default)
Resolution_1280x720_30fps = 2 1280x720 @ 30fps (HD)
Resolution_1920x1080_30fps = 3 1920x1080 @ 30fps (Full HD)

RealSenseDepthResolution

RealSense depth camera resolution options.

Value Description
Resolution_480x270_90fps = 0 480x270 @ 90fps
Resolution_640x480_90fps = 1 640x480 @ 90fps
Resolution_848x480_90fps = 2 848x480 @ 90fps (default)
Resolution_1280x720_30fps = 3 1280x720 @ 30fps (HD)

StartSearchPath

Which start a body takes while the start search holds it, read from TrackedBody.StartSearchRoute.

Value Description
Unknown = 0 No winner has been measured against the guide yet, or none stood within reach or far enough to decide. The body's own start runs as it does without the search.
InReach = 1 The guide stands within reach of the winner, so the body's own start runs as it does without the search.
Far = 2 The winner stands farther than the reach from the guide, so the tracker refines from the winner and not from the guide.

TrackedMotion

Flags enum — values can be combined with |.

Value Description
None = 0
RotationX = 1 << 0
RotationY = 1 << 1
RotationZ = 1 << 2
TranslationX = 1 << 3
TranslationY = 1 << 4
TranslationZ = 1 << 5

TrackingConfidence

The one state of a tracked body, read from TrackedBody.Confidence. It follows the same score and the same start, confirm and stop bars that decide TrackedBody.IsTracking.

Value Description
Lost = 0 The tracker cannot vouch for the pose. It has not found the body yet, or the evidence has been missing for long enough that the displayed pose is no longer supported by anything the camera has seen. This is a report and the tracker does not reset itself.
Degraded = 1 The pose is still worth displaying, but the current step did not verify it.
Tracked = 2 The solve of the current step was accepted.

TrackingConfidenceReason

Why a body is in the state that TrackedBody.Confidence reports.

Value Description
Accepted = 0 The solve of the current step was accepted.
NotStarted = 1 The solver is not running on this body. It has not been found yet, or it was reset.
OutOfView = 2 The body is out of the camera's view and is held in the world frame. No evidence is expected, so none is missing.
Settling = 3 The body is inside the settling window that follows a start, while the solve is still converging.
Unverified = 4 The solver is running and the output of the current step was not accepted, but the score still clears the stop bar.
BelowHold = 5 The score has stayed below the stop bar for the counted number of steps in a row.
BelowAcquire = 6 The body is lost and has not yet cleared the start bar for the counted number of steps in a row.

TrackingMethod

Value Description
Silhouette = 0
Edge = 1

ViewpointPreset

Value Description
FullSphere Full sphere — all viewing angles (default).
UpperHemisphere Upper hemisphere — top + side views, cuts bottom-up views. (-10° to 90°)
SideRing Mostly horizontal views for objects at camera height. (-20° to 30°)
Custom Custom elevation range.