Interface BoardCamera

The interface for the board camera.

interface BoardCamera {
    boundaries?: Boundaries;
    position: Point;
    rotation: number;
    rotationBoundaries?: RotationLimits;
    viewPortHeight: number;
    viewPortWidth: number;
    zoomBoundaries?: ZoomLevelLimits;
    zoomLevel: number;
    convertFromViewPort2WorldSpace(point: Point): Point;
    convertFromWorld2ViewPort(point: Point): Point;
    getCameraOriginInWindow(centerInWindow: Point): Point;
    getTransform(
        devicePixelRatio: number,
        alignCoordinateSystem: boolean,
    ): { a: number; b: number; c: number; d: number; e: number; f: number };
    setHorizontalBoundaries(min: number, max: number): void;
    setMinZoomLevel(minZoomLevel: number): void;
    setPosition(destination: Point): boolean;
    setRotation(rotation: number): boolean;
    setVerticalBoundaries(min: number, max: number): void;
    setZoomLevel(zoomLevel: number): boolean;
}

Hierarchy (View Summary)

BoardCamera
- ObservableBoardCamera

Implemented by

BaseCamera

Index

Properties

boundaries? position rotation rotationBoundaries? viewPortHeight viewPortWidth zoomBoundaries? zoomLevel

Methods

convertFromViewPort2WorldSpace convertFromWorld2ViewPort getCameraOriginInWindow getTransform setHorizontalBoundaries setMinZoomLevel setPosition setRotation setVerticalBoundaries setZoomLevel

Properties

`Optional`boundaries

boundaries?: Boundaries

position

position: Point

rotation

rotation: number

`Optional`rotationBoundaries

rotationBoundaries?: RotationLimits

viewPortHeight

viewPortHeight: number

viewPortWidth

viewPortWidth: number

`Optional`zoomBoundaries

zoomBoundaries?: ZoomLevelLimits

zoomLevel

zoomLevel: number

Methods

convertFromViewPort2WorldSpace

convertFromViewPort2WorldSpace(point: Point): Point
Parameters
- point: Point
Returns Point
- Defined in board-camera/interface.ts:40

convertFromWorld2ViewPort

convertFromWorld2ViewPort(point: Point): Point
Parameters
- point: Point
Returns Point
- Defined in board-camera/interface.ts:41

getCameraOriginInWindow

getCameraOriginInWindow(centerInWindow: Point): Point
Parameters
- centerInWindow: Point
Returns Point
- Defined in board-camera/interface.ts:39

getTransform

getTransform(
devicePixelRatio: number,
alignCoordinateSystem: boolean,
): { a: number; b: number; c: number; d: number; e: number; f: number }
Parameters
- devicePixelRatio: number
- alignCoordinateSystem: boolean
Returns { a: number; b: number; c: number; d: number; e: number; f: number }
- Defined in board-camera/interface.ts:42

setHorizontalBoundaries

setHorizontalBoundaries(min: number, max: number): void
Parameters
- min: number
- max: number
Returns void
- Defined in board-camera/interface.ts:37

setMinZoomLevel

setMinZoomLevel(minZoomLevel: number): void
Parameters
- minZoomLevel: number
Returns void
- Defined in board-camera/interface.ts:36

setPosition

setPosition(destination: Point): boolean
Parameters
- destination: Point
Returns boolean
- Defined in board-camera/interface.ts:33

setRotation

setRotation(rotation: number): boolean
Parameters
- rotation: number
Returns boolean
- Defined in board-camera/interface.ts:35

setVerticalBoundaries

setVerticalBoundaries(min: number, max: number): void
Parameters
- min: number
- max: number
Returns void
- Defined in board-camera/interface.ts:38

setZoomLevel

setZoomLevel(zoomLevel: number): boolean
Parameters
- zoomLevel: number
Returns boolean
- Defined in board-camera/interface.ts:34