Class XRViewport

XRViewport (webXR)-extension of Viewport, to displaying its branch on Head Mounted and AR (not implemted yet) Devices

Hierarchy (view full)

Viewport
- XRViewport

Constructors

constructor

new XRViewport(): XRViewport
Returns XRViewport
Overrides Viewport.constructor
- Defined in Source/Core/Render/XRViewport.ts:35

Properties

adjustingCamera

adjustingCamera: boolean = true

adjustingFrames

adjustingFrames: boolean = true

camera

camera: ComponentCamera = null

componentsPick

componentsPick: RecycableArray<ComponentPick> = ...

frameCanvasToDestination

frameCanvasToDestination: FramingComplex = ...

frameClientToCanvas

frameClientToCanvas: FramingScaled = ...

frameDestinationToSource

frameDestinationToSource: FramingScaled = ...

frameSourceToRender

frameSourceToRender: FramingScaled = ...

gizmosEnabled

gizmosEnabled: boolean = false

gizmosFilter

gizmosFilter: Map<string, boolean> = ...

gizmosSelected

gizmosSelected: Node[]

name

name: string = "Viewport"

physicsDebugMode

physicsDebugMode: PHYSICS_DEBUGMODE = PHYSICS_DEBUGMODE.NONE

rectDestination

rectDestination: Rectangle

rectSource

rectSource: Rectangle

referenceSpace

referenceSpace: XRReferenceSpace = null

session

session: XRSession = null

vrDevice

vrDevice: ComponentVRDevice = null

Accessors

canvas

get canvas(): HTMLCanvasElement
Retrieve the destination canvas

Returns HTMLCanvasElement
Inherited from Viewport.canvas
- Defined in Source/Core/Render/Viewport.ts:55

context

get context(): CanvasRenderingContext2D
Retrieve the 2D-context attached to the destination canvas

Returns CanvasRenderingContext2D
Inherited from Viewport.context
- Defined in Source/Core/Render/Viewport.ts:61

hasFocus

get hasFocus(): boolean
Returns true if this viewport currently has focus and thus receives keyboard events

Returns boolean
Inherited from Viewport.hasFocus
- Defined in Source/Core/Render/Viewport.ts:48

`Static` default

get default(): XRViewport
To retrieve private static instance of xr viewport, readonly.

Returns XRViewport
- Defined in Source/Core/Render/XRViewport.ts:43

Methods

addEventListener

addEventListener(_type, _handler, _options?): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from Viewport.addEventListener
- Defined in Source/Core/Event/Event.ts:91

adjustCamera

adjustCamera(): void
Adjust the camera parameters to fit the rendering into the render viewport

Returns void
Inherited from Viewport.adjustCamera
- Defined in Source/Core/Render/Viewport.ts:252

adjustFrames

adjustFrames(): void
Adjust all frames involved in the rendering process from the display area in the client up to the renderer canvas

Returns void
Inherited from Viewport.adjustFrames
- Defined in Source/Core/Render/Viewport.ts:210

dispatchEvent

dispatchEvent(_event): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from Viewport.dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

dispatchPointerEvent

dispatchPointerEvent(_event): void
Performs a pick on all ComponentPicks in the branch of this viewport using a ray from its camera through the client coordinates given in the event. Dispatches the event to all nodes hit.
If PICK.CAMERA was chosen as the method to pick, a pick property gets added to the event, which holds the detailed information, but is overwritten for each node.
Parameters
- _event: PointerEvent
Returns void
Inherited from Viewport.dispatchPointerEvent
- Defined in Source/Core/Render/Viewport.ts:181

draw

draw(_prepareBranch?, _xrFrame?): void
Draw the xr viewport displaying its branch. By default, the transforms in the branch are recalculated first. Pass false if calculation was already done for this frame Called from loop method Loop again with the xrFrame parameter handover, as soon as FRAME_REQUEST_XR is called from creator.
Parameters
- _prepareBranch: boolean = true
- _xrFrame: XRFrame = null
Returns void
Overrides Viewport.draw
- Defined in Source/Core/Render/XRViewport.ts:97

getBranch

getBranch(): Node
Retrieve the branch this viewport renders

Returns Node
Inherited from Viewport.getBranch
- Defined in Source/Core/Render/Viewport.ts:108

getCanvasRectangle

getCanvasRectangle(): Rectangle
Retrieve the size of the destination canvas as a rectangle, x and y are always 0

Returns Rectangle
Inherited from Viewport.getCanvasRectangle
- Defined in Source/Core/Render/Viewport.ts:83

getClientRectangle

getClientRectangle(): Rectangle
Retrieve the client rectangle the canvas is displayed and fit in, x and y are always 0

Returns Rectangle
Inherited from Viewport.getClientRectangle
- Defined in Source/Core/Render/Viewport.ts:89

getRayFromClient

getRayFromClient(_point): Ray
Returns a Ray in world coordinates from this camera through the point given in client space
Parameters
- _point: Vector2
Returns Ray
Inherited from Viewport.getRayFromClient
- Defined in Source/Core/Render/Viewport.ts:268

initialize

initialize(_name, _branch, _cameraXR, _canvas): void
Connects the viewport to the given canvas to render the given branch to using the given camera-component, and names the viewport as given.
Parameters
- _name: string
- _branch: Node
- _cameraXR: ComponentVRDevice
- _canvas: HTMLCanvasElement
Returns void
Overrides Viewport.initialize
- Defined in Source/Core/Render/XRViewport.ts:50

initializeAR

initializeAR(_arSessionMode?, _arReferenceSpaceType?): Promise<void>
The AR session could be initialized here. Up till now not implemented.
Parameters
- _arSessionMode: IMMERSIVE_VR = null
- _arReferenceSpaceType: XR_REFERENCE_SPACE = null
Returns Promise<void>
- Defined in Source/Core/Render/XRViewport.ts:88

initializeVR

initializeVR(_vrSessionMode?, _vrReferenceSpaceType?, _vrController?): Promise<void>
The VR Session is initialized here, also VR - Controller are initialized, if boolean is true. Creator has to call FrameRequestXR after this Method to run the viewport in virtual reality.
Parameters
- _vrSessionMode: IMMERSIVE_VR = XR_SESSION_MODE.IMMERSIVE_VR
- _vrReferenceSpaceType: XR_REFERENCE_SPACE = XR_REFERENCE_SPACE.LOCAL
- _vrController: boolean = false
Returns Promise<void>
- Defined in Source/Core/Render/XRViewport.ts:58

pointClientToProjection

pointClientToProjection(_client): Vector2
Returns a point on a projection surface in the hypothetical distance of 1 to the camera
matching the given point on the client rectangle TODO: examine, if this should be a camera-method. Current implementation is for central-projection
Parameters
- _client: Vector2
Returns Vector2
Inherited from Viewport.pointClientToProjection
- Defined in Source/Core/Render/Viewport.ts:326

pointClientToRender

pointClientToRender(_client): Vector2
Returns a point on the render-rectangle matching the given point on the client rectangle
Parameters
- _client: Vector2
Returns Vector2
Inherited from Viewport.pointClientToRender
- Defined in Source/Core/Render/Viewport.ts:314

pointClientToScreen

pointClientToScreen(_client): Vector2
Returns a point in the browser page matching the given point of the viewport
Parameters
- _client: Vector2
Returns Vector2
Inherited from Viewport.pointClientToScreen
- Defined in Source/Core/Render/Viewport.ts:369

pointClientToSource

pointClientToSource(_client): Vector2
Returns a point on the source-rectangle matching the given point on the client rectangle
Parameters
- _client: Vector2
Returns Vector2
Inherited from Viewport.pointClientToSource
- Defined in Source/Core/Render/Viewport.ts:293

pointClipToCanvas

pointClipToCanvas(_normed): Vector2
Returns a point in the client rectangle matching the given point in normed clipspace rectangle, which stretches from -1 to 1 in both dimensions, y pointing up
Parameters
- _normed: Vector2
Returns Vector2
Inherited from Viewport.pointClipToCanvas
- Defined in Source/Core/Render/Viewport.ts:361

pointClipToClient

pointClipToClient(_normed): Vector2
Returns a point in the client rectangle matching the given point in normed clipspace rectangle, which stretches from -1 to 1 in both dimensions, y pointing up
Parameters
- _normed: Vector2
Returns Vector2
Inherited from Viewport.pointClipToClient
- Defined in Source/Core/Render/Viewport.ts:346

pointSourceToRender

pointSourceToRender(_source): Vector2
Returns a point on the render-rectangle matching the given point on the source rectangle
Parameters
- _source: Vector2
Returns Vector2
Inherited from Viewport.pointSourceToRender
- Defined in Source/Core/Render/Viewport.ts:304

pointWorldToClient

pointWorldToClient(_position): Vector2
Returns a point on the client rectangle matching the projection of the given point in world space
Parameters
- _position: Vector3
Returns Vector2
Inherited from Viewport.pointWorldToClient
- Defined in Source/Core/Render/Viewport.ts:284

prepare

prepare(_prepareBranch?): void
Adjusts all frames and the camera to fit the current size of the canvas. Prepares the branch for rendering.
Parameters
- _prepareBranch: boolean = true
Returns void
Inherited from Viewport.prepare
- Defined in Source/Core/Render/Viewport.ts:147

prepareBranch

prepareBranch(): void
Prepares all nodes in the branch for rendering by updating their world transforms etc.

Returns void
Inherited from Viewport.prepareBranch
- Defined in Source/Core/Render/Viewport.ts:164

removeEventListener

removeEventListener(_type, _handler, _options?): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from Viewport.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

setBranch

setBranch(_branch): void
Set the branch to be drawn in the viewport.
Parameters
- _branch: Node
Returns void
Inherited from Viewport.setBranch
- Defined in Source/Core/Render/Viewport.ts:98

Class XRViewport

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns XRViewport

Properties

adjustingCamera

adjustingFrames

camera

componentsPick

frameCanvasToDestination

frameClientToCanvas

frameDestinationToSource

frameSourceToRender

gizmosEnabled

gizmosFilter

gizmosSelected

name

physicsDebugMode

rectDestination

rectSource

referenceSpace

session

vrDevice

Accessors

canvas

Returns HTMLCanvasElement

context

Returns CanvasRenderingContext2D

hasFocus

Returns boolean

Static default

Returns XRViewport

Methods

addEventListener

Parameters

Returns void

adjustCamera

Returns void

adjustFrames

Returns void

dispatchEvent

Parameters

Returns boolean

dispatchPointerEvent

Parameters

Returns void

draw

Parameters

Returns void

getBranch

Returns Node

getCanvasRectangle

Returns Rectangle

getClientRectangle

Returns Rectangle

getRayFromClient

Parameters

Returns Ray

initialize

Parameters

Returns void

initializeAR

Parameters

Returns Promise<void>

initializeVR

Parameters

Returns Promise<void>

pointClientToProjection

Parameters

Returns Vector2

pointClientToRender

Parameters

Returns Vector2

pointClientToScreen

`Static` default