Class Viewport

adjustingCamera

adjustingFrames

camera

componentsPick

frameCanvasToDestination

frameClientToCanvas

frameDestinationToSource

frameSourceToRender

gizmosEnabled

gizmosFilter

gizmosSelected

name

physicsDebugMode

rectDestination

rectSource

canvas

• get canvas(): HTMLCanvasElement

• Retrieve the destination canvas

  Returns HTMLCanvasElement

context

• get context(): CanvasRenderingContext2D

• Retrieve the 2D-context attached to the destination canvas

  Returns CanvasRenderingContext2D

hasFocus

• get hasFocus(): boolean

• Returns true if this viewport currently has focus and thus receives keyboard events

  Returns boolean

adjustCamera

• adjustCamera(): void

• Adjust the camera parameters to fit the rendering into the render viewport

  Returns void

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

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

draw

• draw(_prepareBranch?): void

• Draw this viewport displaying its branch. By default, the transforms in the branch are recalculated first. Pass false if calculation was already done for this frame

  Parameters

  • _prepareBranch: boolean = true

  Returns void

getBranch

• getBranch(): Node

• Retrieve the branch this viewport renders

  Returns Node

getCanvasRectangle

• getCanvasRectangle(): Rectangle

• Retrieve the size of the destination canvas as a rectangle, x and y are always 0

  Returns Rectangle

getClientRectangle

• getClientRectangle(): Rectangle

• Retrieve the client rectangle the canvas is displayed and fit in, x and y are always 0

  Returns Rectangle

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

initialize

• initialize(_name, _branch, _camera, _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
  • _camera: ComponentCamera
  • _canvas: HTMLCanvasElement

  Returns void

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

pointClientToRender

• pointClientToRender(_client): Vector2

• Returns a point on the render-rectangle matching the given point on the client rectangle

  Parameters

  • _client: Vector2

  Returns Vector2

pointClientToScreen

• pointClientToScreen(_client): Vector2

• Returns a point in the browser page matching the given point of the viewport

  Parameters

  • _client: Vector2

  Returns Vector2

pointClientToSource

• pointClientToSource(_client): Vector2

• Returns a point on the source-rectangle matching the given point on the client rectangle

  Parameters

  • _client: Vector2

  Returns Vector2

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

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

pointSourceToRender

• pointSourceToRender(_source): Vector2

• Returns a point on the render-rectangle matching the given point on the source rectangle

  Parameters

  • _source: Vector2

  Returns Vector2

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

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

prepareBranch

• prepareBranch(): void

• Prepares all nodes in the branch for rendering by updating their world transforms etc.

  Returns void

setBranch

• setBranch(_branch): void

• Set the branch to be drawn in the viewport.

  Parameters

  • _branch: Node

  Returns void