NatML
Search…
⌃K

MLXRCpuDepthFeature

class MLXRCpuDepthFeature : MLDepthFeature
This feature provides functionality for working with camera depth data from Unity ARFoundation.
This class is distributed in the ai.natml.natml.arfoundation integration library.

Creating the Feature

/// <summary>
/// Create an AR depth image feature.
/// </summary>
/// <param name="image">Augmented reality image.</param>
/// <param name="camera">AR session camera.</param>
/// <param name="orientation">Image orientation. If `Unknown`, this will default to the screen orientation.</param>
MLXRCpuDepthFeature (XRCpuImage image, Camera camera, ScreenOrientation orientation = 0);
INCOMPLETE.

Inspecting the Feature

The depth feature exposes its underlying type, along with convenience properties for inspecting the aforementioned type.

Feature Type

/// <summary>
/// Feature type.
/// </summary>
MLFeatureType type { get; }
Refer to the Inspecting the Feature section of the MLDepthFeature class for more information.

Depth Map Width

/// <summary>
/// Depth map width.
/// </summary>
int width { get; }
Refer to the Depth Map Width section of the MLDepthFeature class for more information.

Depth Map Height

/// <summary>
/// Depth map height.
/// </summary>
int height { get; }
Refer to the Depth Map Height section of the MLDepthFeature class for more information.

Sampling Pixel Depth

/// <summary>
/// Sample the depth feature at a given point.
/// </summary>
/// <param name="point">Point to sample in normalized coordinates.</param>
/// <returns>Depth in meters.</returns>
float Sample (Vector2 point);
Refer to the Sampling Pixel Depth section of the MLDepthFeature class for more information.

Projecting to 3D Space

/// <summary>
/// Project a 2D point into 3D world space using depth.
/// </summary>
/// <param name="point">Point to transform in normalized camera coordinates.</param>
/// <returns>Projected point in 3D world space.</param>
Vector3 ViewportToWorldPoint (Vector2 point);
Refer to the Projecting to 3D Space section of the MLDepthFeature class for more information.