Class DefaultProjections

Implements

Projections

Index

Constructors

Properties

context options

Methods

getCameraProjection getClipProjection getViewportClipProjection projectDOMPointToScene projectDOMPointToViewport projectDOMRectToScene projectDOMRectToViewport projectScenePointToDOM projectScenePointToViewport projectSceneRectToDOM projectSceneRectToViewport projectViewportPointToDOM projectViewportPointToScene projectViewportRectToDOM projectViewportRectToScene

Constructors

constructor

new DefaultProjections(
context: RenderContext,
options?: ProjectionOptions,
): DefaultProjections
Parameters
- context: RenderContext
- options: ProjectionOptions = ...
Returns DefaultProjections
- Defined in rendering/projection/projections.ts:156

Properties

`Protected` `Readonly`context

context: RenderContext

`Protected` `Readonly`options

options: ProjectionOptions = ...

Methods

getCameraProjection

getCameraProjection(camera: Camera2D, target?: Mat2D): Mat2D
Get camera projection.
Parameters
- camera: Camera2D
  Camera to create projection from
- Optionaltarget: Mat2D
  Optional matrix to store the projection in. Will allocate a new instance otherwise
Returns Mat2D
target or newly allocated matrix
Implementation of Projections.getCameraProjection
- Defined in rendering/projection/projections.ts:271

getClipProjection

getClipProjection(camera?: Camera2D, target?: Mat2D): Mat2D
Get clip projection.
Parameters
- Optionalcamera: Camera2D
  Optional camera projection to apply
- Optionaltarget: Mat2D
  Optional matrix to store the projection in. Will allocate a new instance otherwise
Returns Mat2D
target or newly allocated matrix
Implementation of Projections.getClipProjection
- Defined in rendering/projection/projections.ts:279

getViewportClipProjection

getViewportClipProjection(target?: Mat2D): Mat2D
Get clip projection in viewport space.
Parameters
- Optionaltarget: Mat2D
  Optional matrix to store the projection in. Will allocate a new instance otherwise
Returns Mat2D
target or newly allocated matrix
Implementation of Projections.getViewportClipProjection
- Defined in rendering/projection/projections.ts:293

projectDOMPointToScene

projectDOMPointToScene(point: Vec2, camera: Camera2D): Vec2
Project a DOM point (e.g., from pointer events) to scene space.
Parameters
- point: Vec2
  DOM point
- camera: Camera2D
  Camera projection to apply
Returns Vec2
point, modified
Implementation of Projections.projectDOMPointToScene
- Defined in rendering/projection/projections.ts:169

projectDOMPointToViewport

projectDOMPointToViewport(point: Vec2): Vec2
Project a DOM point (e.g., from pointer events) to viewport space.
Parameters
- point: Vec2
  DOM point
Returns Vec2
point, modified
Implementation of Projections.projectDOMPointToViewport
- Defined in rendering/projection/projections.ts:163

projectDOMRectToScene

projectDOMRectToScene(rect: Rect, camera: Camera2D): Rect
Project a DOM rect (e.g., from pointer events) to scene space.
Parameters
- rect: Rect
  DOM rect
- camera: Camera2D
  Camera projection to apply
Returns Rect
rect, modified

Remarks
Only takes and produces axis-aligned rects.
Implementation of Projections.projectDOMRectToScene
- Defined in rendering/projection/projections.ts:223

projectDOMRectToViewport

projectDOMRectToViewport(rect: Rect): Rect
Project a DOM rect (e.g., from pointer events) to viewport space.
Parameters
- rect: Rect
  DOM rect
Returns Rect
rect, modified

Remarks
Only takes and produces axis-aligned rects.
Implementation of Projections.projectDOMRectToViewport
- Defined in rendering/projection/projections.ts:217

projectScenePointToDOM

projectScenePointToDOM(point: Vec2, camera: Camera2D): Vec2
Project scene point point to DOM space.
Parameters
- point: Vec2
  Point to project
- camera: Camera2D
  Camera projection to apply
Returns Vec2
point, modified
Implementation of Projections.projectScenePointToDOM
- Defined in rendering/projection/projections.ts:209

projectScenePointToViewport

projectScenePointToViewport(point: Vec2, camera: Camera2D): Vec2
Project scene point point to viewport space.
Parameters
- point: Vec2
  Point to project
- camera: Camera2D
  Camera projection to apply
Returns Vec2
point, modified
Implementation of Projections.projectScenePointToViewport
- Defined in rendering/projection/projections.ts:196

projectSceneRectToDOM

projectSceneRectToDOM(rect: Rect, camera: Camera2D): Rect
Project scene rect rect to viewport space.
Parameters
- rect: Rect
  Rect to project
- camera: Camera2D
  Camera projection to apply
Returns Rect
rect, modified

Remarks
Only takes and produces axis-aligned rects.
Implementation of Projections.projectSceneRectToDOM
- Defined in rendering/projection/projections.ts:263

projectSceneRectToViewport

projectSceneRectToViewport(rect: Rect, camera: Camera2D): Rect
Project scene rect rect to viewport space.
Parameters
- rect: Rect
  Rect to project
- camera: Camera2D
  Camera projection to apply
Returns Rect
rect, modified

Remarks
Only takes and produces axis-aligned rects.
Implementation of Projections.projectSceneRectToViewport
- Defined in rendering/projection/projections.ts:250

projectViewportPointToDOM

projectViewportPointToDOM(point: Vec2): Vec2
Project viewport point point to DOM space.
Parameters
- point: Vec2
  Point to project
Returns Vec2
point, modified
Implementation of Projections.projectViewportPointToDOM
- Defined in rendering/projection/projections.ts:190

projectViewportPointToScene

projectViewportPointToScene(point: Vec2, camera: Camera2D): Vec2
Project viewport point point to scene space.
Parameters
- point: Vec2
  Point to project
- camera: Camera2D
  Camera projection to apply
Returns Vec2
point, modified
Implementation of Projections.projectViewportPointToScene
- Defined in rendering/projection/projections.ts:177

projectViewportRectToDOM

projectViewportRectToDOM(rect: Rect): Rect
Project viewport rect rect to scene space.
Parameters
- rect: Rect
  Rect to project
Returns Rect
rect, modified

Remarks
Only takes and produces axis-aligned rects.
Implementation of Projections.projectViewportRectToDOM
- Defined in rendering/projection/projections.ts:244

projectViewportRectToScene

projectViewportRectToScene(rect: Rect, camera: Camera2D): Rect
Project viewport rect rect to scene space.
Parameters
- rect: Rect
  Rect to project
- camera: Camera2D
  Camera projection to apply
Returns Rect
rect, modified

Remarks
Only takes and produces axis-aligned rects.
Implementation of Projections.projectViewportRectToScene
- Defined in rendering/projection/projections.ts:231