Interface Projections

Service to project points

interface Projections {
    getCameraProjection(camera: Camera2D, target?: Mat2D): Mat2D;
    getClipProjection(camera?: Camera2D, target?: Mat2D): Mat2D;
    getViewportClipProjection(target?: Mat2D): Mat2D;
    projectDOMPointToScene(point: Vec2, camera: Camera2D): Vec2;
    projectDOMPointToViewport(point: Vec2): Vec2;
    projectDOMRectToScene(rect: Rect, camera: Camera2D): Rect;
    projectDOMRectToViewport(rect: Rect): Rect;
    projectScenePointToDOM(point: Vec2, camera: Camera2D): Vec2;
    projectScenePointToViewport(point: Vec2, camera: Camera2D): Vec2;
    projectSceneRectToDOM(rect: Rect, camera: Camera2D): Rect;
    projectSceneRectToViewport(rect: Rect, camera: Camera2D): Rect;
    projectViewportPointToDOM(point: Vec2): Vec2;
    projectViewportPointToScene(point: Vec2, camera: Camera2D): Vec2;
    projectViewportRectToDOM(rect: Rect): Rect;
    projectViewportRectToScene(rect: Rect, camera: Camera2D): Rect;
}

Implemented by

DefaultProjections

Index

Methods

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

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
- Defined in rendering/projection/projections.ts:131

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
- Defined in rendering/projection/projections.ts:139

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
- Defined in rendering/projection/projections.ts:146

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
- Defined in rendering/projection/projections.ts:28

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
- Defined in rendering/projection/projections.ts:20

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.
- Defined in rendering/projection/projections.ts:80

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.
- Defined in rendering/projection/projections.ts:69

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
- Defined in rendering/projection/projections.ts:59

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
- Defined in rendering/projection/projections.ts:51

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.
- Defined in rendering/projection/projections.ts:123

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.
- Defined in rendering/projection/projections.ts:112

projectViewportPointToDOM

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

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
- Defined in rendering/projection/projections.ts:36

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.
- Defined in rendering/projection/projections.ts:101

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.
- Defined in rendering/projection/projections.ts:91