DepthCorrelatedCoordinateMapper DepthCorrelatedCoordinateMapper DepthCorrelatedCoordinateMapper DepthCorrelatedCoordinateMapper Class

Definition

Maps 2D points in a MediaFrameSource to 3D space or to a frame from a different MediaFrameSource using data from a DepthMediaFrame.

public : sealed class DepthCorrelatedCoordinateMapper : IClosable, IDepthCorrelatedCoordinateMapperpublic sealed class DepthCorrelatedCoordinateMapper : IDisposable, IDepthCorrelatedCoordinateMapperPublic NotInheritable Class DepthCorrelatedCoordinateMapper Implements IDisposable, IDepthCorrelatedCoordinateMapper// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

Get an instance of this class by calling the TryCreateCoordinateMapper of a DepthMediaFrame.

Methods

Close() Close() Close() Close()

Disposes of the object and associated resources.

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

Remarks

The Close method is used by Universal Windows app using JavaScript. For apps written using the .NET Framework 4.5 in C# and VB.NET, the Close method is exposed as the Dispose() method on the DepthCorrelatedCoordinateMapper object. For apps written in C++, the Close method will be called when using the delete keyword on the object.

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()

MapPoint(Point, SpatialCoordinateSystem, CameraIntrinsics) MapPoint(Point, SpatialCoordinateSystem, CameraIntrinsics) MapPoint(Point, SpatialCoordinateSystem, CameraIntrinsics) MapPoint(Point, SpatialCoordinateSystem, CameraIntrinsics)

Maps a point from one MediaFrameSource to another, using depth information from the DepthMediaFrame from which the coordinate mapper was created with a call to TryCreateCoordinateMapper.

public : Point MapPoint(Point sourcePoint, SpatialCoordinateSystem targetCoordinateSystem, CameraIntrinsics targetCameraIntrinsics)public Point MapPoint(Point sourcePoint, SpatialCoordinateSystem targetCoordinateSystem, CameraIntrinsics targetCameraIntrinsics)Public Function MapPoint(sourcePoint As Point, targetCoordinateSystem As SpatialCoordinateSystem, targetCameraIntrinsics As CameraIntrinsics) As Point// You can use this method in JavaScript.
Parameters
sourcePoint
Point Point Point Point

The source point to be mapped to the coordinate system of a different media frame source, which is specified in the targetCoordinateSystem parameter.

targetCoordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system of the target media frame source to which the point is mapped.

targetCameraIntrinsics
CameraIntrinsics CameraIntrinsics CameraIntrinsics CameraIntrinsics

The camera intrinsics describing the projection and distortion models of the media frame source to which the point is mapped.

Returns

A mapped point.

MapPoints(Point[], SpatialCoordinateSystem, CameraIntrinsics, Point[]) MapPoints(Point[], SpatialCoordinateSystem, CameraIntrinsics, Point[]) MapPoints(Point[], SpatialCoordinateSystem, CameraIntrinsics, Point[]) MapPoints(Point[], SpatialCoordinateSystem, CameraIntrinsics, Point[])

Maps an array of points from one MediaFrameSource to another, using depth information from the DepthMediaFrame from which the coordinate mapper was created with a call to TryCreateCoordinateMapper.

public : void MapPoints(Point[] sourcePoints, SpatialCoordinateSystem targetCoordinateSystem, CameraIntrinsics targetCameraIntrinsics, Point[] results)public void MapPoints(Point[] sourcePoints, SpatialCoordinateSystem targetCoordinateSystem, CameraIntrinsics targetCameraIntrinsics, Point[] results)Public Function MapPoints(sourcePoints As Point[], targetCoordinateSystem As SpatialCoordinateSystem, targetCameraIntrinsics As CameraIntrinsics, results As Point[]) As void// You can use this method in JavaScript.
Parameters
sourcePoints
Point[] Point[] Point[] Point[]

An array of source points to be mapped to the coordinate system of a different media frame source, which is specified in the targetCoordinateSystem parameter.

targetCoordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system of the target media frame source to which the points are mapped.

targetCameraIntrinsics
CameraIntrinsics CameraIntrinsics CameraIntrinsics CameraIntrinsics

The camera intrinsics describing the projection and distortion models of the media frame source to which the points are mapped.

results
Point[] Point[] Point[] Point[]

An array mapped points.

UnprojectPoint(Point, SpatialCoordinateSystem) UnprojectPoint(Point, SpatialCoordinateSystem) UnprojectPoint(Point, SpatialCoordinateSystem) UnprojectPoint(Point, SpatialCoordinateSystem)

Unprojects a 2D point from a MediaFrameSource to a point in 3D space, using depth information from the DepthMediaFrame from which the coordinate mapper was created with a call to TryCreateCoordinateMapper.

public : Vector3 UnprojectPoint(Point sourcePoint, SpatialCoordinateSystem targetCoordinateSystem)public Vector3 UnprojectPoint(Point sourcePoint, SpatialCoordinateSystem targetCoordinateSystem)Public Function UnprojectPoint(sourcePoint As Point, targetCoordinateSystem As SpatialCoordinateSystem) As Vector3// You can use this method in JavaScript.
Parameters
sourcePoint
Point Point Point Point

The 2D source point within the MediaFrameSource to map.

targetCoordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system to which the point is unprojected.

Returns
Vector3 Vector3 Vector3 Vector3

An point in 3D space.

UnprojectPoints(Point[], SpatialCoordinateSystem, Vector3[]) UnprojectPoints(Point[], SpatialCoordinateSystem, Vector3[]) UnprojectPoints(Point[], SpatialCoordinateSystem, Vector3[]) UnprojectPoints(Point[], SpatialCoordinateSystem, Vector3[])

Unprojects an array of 2D points from a MediaFrameSource to a point in 3D space, using depth information from the DepthMediaFrame from which the coordinate mapper was created with a call to TryCreateCoordinateMapper.

public : void UnprojectPoints(Point[] sourcePoints, SpatialCoordinateSystem targetCoordinateSystem, Vector3[] results)public void UnprojectPoints(Point[] sourcePoints, SpatialCoordinateSystem targetCoordinateSystem, Vector3[] results)Public Function UnprojectPoints(sourcePoints As Point[], targetCoordinateSystem As SpatialCoordinateSystem, results As Vector3[]) As void// You can use this method in JavaScript.
Parameters
sourcePoints
Point[] Point[] Point[] Point[]

The array of 2D source points within the MediaFrameSource to map.

targetCoordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system to which the points are unprojected.

results
Vector3[] Vector3[] Vector3[] Vector3[]

An array of points in 3D space.