HolographicCameraPose HolographicCameraPose HolographicCameraPose HolographicCameraPose Class

Definition

Represents the predicted location of a holographic camera for a particular frame.

public : sealed class HolographicCameraPose : IHolographicCameraPosepublic sealed class HolographicCameraPose : IHolographicCameraPosePublic NotInheritable Class HolographicCameraPose Implements IHolographicCameraPose// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10586.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

Properties

FarPlaneDistance FarPlaneDistance FarPlaneDistance FarPlaneDistance

Gets the far plane distance for this frame, which is set by calling the HolographicCamera.SetFarPlaneDistance method.

public : double FarPlaneDistance { get; }public double FarPlaneDistance { get; }Public ReadOnly Property FarPlaneDistance As double// You can use this property in JavaScript.
Value
double double double double

The far plane distance for this frame, in meters. By default, this is set to 20 meters.

HolographicCamera HolographicCamera HolographicCamera HolographicCamera

Gets the HolographicCamera that's described by this camera pose.

public : HolographicCamera HolographicCamera { get; }public HolographicCamera HolographicCamera { get; }Public ReadOnly Property HolographicCamera As HolographicCamera// You can use this property in JavaScript.

NearPlaneDistance NearPlaneDistance NearPlaneDistance NearPlaneDistance

Gets the near plane distance for this frame, which you set by calling the HolographicCamera.SetNearPlaneDistance method.

public : double NearPlaneDistance { get; }public double NearPlaneDistance { get; }Public ReadOnly Property NearPlaneDistance As double// You can use this property in JavaScript.
Value
double double double double

The near plane distance for this frame, in meters. By default, this is set to 0.01 meters.

ProjectionTransform ProjectionTransform ProjectionTransform ProjectionTransform

Gets the stereo projection transform for this camera pose.

public : HolographicStereoTransform ProjectionTransform { get; }public HolographicStereoTransform ProjectionTransform { get; }Public ReadOnly Property ProjectionTransform As HolographicStereoTransform// You can use this property in JavaScript.

Viewport Viewport Viewport Viewport

Gets the viewport rectangle that the app must render to for this camera in this frame.

public : Rect Viewport { get; }public Rect Viewport { get; }Public ReadOnly Property Viewport As Rect// You can use this property in JavaScript.
Value
Rect Rect Rect Rect

The viewport rect.

Remarks

To shrink this viewport for future frames, set the ViewportScaleFactor on the HolographicCamera.

Methods

TryGetCullingFrustum(SpatialCoordinateSystem) TryGetCullingFrustum(SpatialCoordinateSystem) TryGetCullingFrustum(SpatialCoordinateSystem) TryGetCullingFrustum(SpatialCoordinateSystem)

Gets the predicted conservative culling frustum for this camera pose, expressed in the specified coordinate system.

public : IReference<SpatialBoundingFrustum> TryGetCullingFrustum(SpatialCoordinateSystem coordinateSystem)public Nullable<SpatialBoundingFrustum> TryGetCullingFrustum(SpatialCoordinateSystem coordinateSystem)Public Function TryGetCullingFrustum(coordinateSystem As SpatialCoordinateSystem) As Nullable( Of SpatialBoundingFrustum )// You can use this method in JavaScript.
Parameters
coordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system in which to express the culling frustum.

Returns
IReference<SpatialBoundingFrustum> Nullable<SpatialBoundingFrustum> Nullable<SpatialBoundingFrustum> Nullable<SpatialBoundingFrustum>

The culling frustum.

Remarks

This frustum is wider than the displays to account for uncertainty in the camera's pose prediction. As you get closer to the target frame time, this uncertainty reduces and the culling frustum gets smaller in size. This method will return null if the specified coordinate system cannot be located at the moment.

TryGetViewTransform(SpatialCoordinateSystem) TryGetViewTransform(SpatialCoordinateSystem) TryGetViewTransform(SpatialCoordinateSystem) TryGetViewTransform(SpatialCoordinateSystem)

Gets the stereo view transform for this camera pose, expressed as a transform from the specified coordinate system. This method will return null if the specified coordinate system cannot be located at the moment.

public : IReference<HolographicStereoTransform> TryGetViewTransform(SpatialCoordinateSystem coordinateSystem)public Nullable<HolographicStereoTransform> TryGetViewTransform(SpatialCoordinateSystem coordinateSystem)Public Function TryGetViewTransform(coordinateSystem As SpatialCoordinateSystem) As Nullable( Of HolographicStereoTransform )// You can use this method in JavaScript.
Parameters
coordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system from which the rendered geometry should be transformed.

Returns
IReference<HolographicStereoTransform> Nullable<HolographicStereoTransform> Nullable<HolographicStereoTransform> Nullable<HolographicStereoTransform>

The transforms.

Remarks

This method will return null if the specified coordinate system cannot be located at the moment.

TryGetVisibleFrustum(SpatialCoordinateSystem) TryGetVisibleFrustum(SpatialCoordinateSystem) TryGetVisibleFrustum(SpatialCoordinateSystem) TryGetVisibleFrustum(SpatialCoordinateSystem)

Gets the predicted view frustum for the current pose, expressed in the specified coordinate system.

public : IReference<SpatialBoundingFrustum> TryGetVisibleFrustum(SpatialCoordinateSystem coordinateSystem)public Nullable<SpatialBoundingFrustum> TryGetVisibleFrustum(SpatialCoordinateSystem coordinateSystem)Public Function TryGetVisibleFrustum(coordinateSystem As SpatialCoordinateSystem) As Nullable( Of SpatialBoundingFrustum )// You can use this method in JavaScript.
Parameters
coordinateSystem
SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem SpatialCoordinateSystem

The coordinate system in which to express the visible frustum.

Returns
IReference<SpatialBoundingFrustum> Nullable<SpatialBoundingFrustum> Nullable<SpatialBoundingFrustum> Nullable<SpatialBoundingFrustum>

The visible frustum.

Remarks

If this is a stereo display, this is the combined frustum of both stereo views, including the left and right view and projection matrices.

This frustum shares the same dimensions as the true view frustum at the time of rendering, although it may be off by some amount due to prediction error. Call TryGetCullingFrustum to get a conservative frustum that takes this uncertainty into account.

This method will return null if the specified coordinate system cannot be located at the moment.