akasha.xr

Class XRView

java.lang.Object

akasha.core.JsObject

akasha.xr.XRView

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="XRView")
public class XRView
extends JsObject

The WebXR Device API's XRView interface describes a single view into the XR scene for a specific frame, providing orientation and position information for the viewpoint. You can think of it as a description of a specific eye or camera and how it views the world. A 3D frame will involve two views, one for each eye, separated by an appropriate distance which approximates the distance between the viewer's eyes. This allows the two views, when projected in isolation into the appropriate eyes, to simulate a 3D world.

See Also:

XRView - MDN, # xrview-interface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XRView()

Method Summary

Modifier and Type	Method and Description
java.lang.String	eye() The XRView interface's read-only eye property is a string taken from the XREye enumerated type, indicating which eye's viewpoint the XRView represents: left or right.
boolean	isFirstPersonObserver()
boolean	isIsFirstPersonObserverSupported()
Float32Array	projectionMatrix() The XRView interface's read-only projectionMatrix property specifies the projection matrix to apply to the underlying view.
java.lang.Double	recommendedViewportScale()
void	requestViewportScale(java.lang.Double scale)
XRRigidTransform	transform() The read-only transform property of the XRView interface is an XRRigidTransform object which provides the position and orientation of the viewpoint relative to the XRReferenceSpace specified when the XRFrame.getViewerPose() method was called to obtain the view object.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XRView

protected XRView()

Method Detail

eye

@JsProperty(name="eye")
 @Nonnull
 @XREye
public java.lang.String eye()

The XRView interface's read-only eye property is a string taken from the XREye enumerated type, indicating which eye's viewpoint the XRView represents: left or right. For views which represent neither eye, such as monoscopic views, this property's value is none.

See Also:

XRView.eye - MDN, XRView.eye - WebXR Device API

isIsFirstPersonObserverSupported

@JsOverlay
public final boolean isIsFirstPersonObserverSupported()

isFirstPersonObserver

@JsProperty(name="isFirstPersonObserver")
public boolean isFirstPersonObserver()

projectionMatrix

@JsProperty(name="projectionMatrix")
 @Nonnull
public Float32Array projectionMatrix()

The XRView interface's read-only projectionMatrix property specifies the projection matrix to apply to the underlying view. This should be used to integrate perspective to everything in the scene, in order to ensure the result is consistent with what the eye expects to see.

See Also:

XRView.projectionMatrix - MDN, XRView.projectionMatrix - WebXR Device API

recommendedViewportScale

@JsProperty(name="recommendedViewportScale")
 @Nullable
public java.lang.Double recommendedViewportScale()

transform

@JsProperty(name="transform")
 @Nonnull
public XRRigidTransform transform()

The read-only transform property of the XRView interface is an XRRigidTransform object which provides the position and orientation of the viewpoint relative to the XRReferenceSpace specified when the XRFrame.getViewerPose() method was called to obtain the view object.

See Also:

XRView.transform - MDN, XRView.transform - WebXR Device API

requestViewportScale

public void requestViewportScale(@Nullable
                                 java.lang.Double scale)