Class Viewport

Accessors

canvasToScreenTransform screenToCanvasTransform visibleRect

Methods

canvasToScreen computeZoomToTransform getResolution getRotationAngle getScaleFactor getScaleFactorToNearestPowerOfTen getScreenRectSize getSizeOfPixelOnCanvas getTemporaryClone resetTransform roundPoint screenToCanvas snapToGrid zoomTo getGridSize roundPoint roundScaleRatio transformBy

Accessors

canvasToScreenTransform

screenToCanvasTransform

visibleRect

  • get visibleRect(): Rect2

  • Get the screen's visible region transformed into canvas space.

    Returns Rect2

Methods

canvasToScreen

  • canvasToScreen(canvasPoint): Vec3

  • Parameters

    Returns Vec3

    the given point transformed into screen coordinates.

computeZoomToTransform

  • computeZoomToTransform(toMakeVisible, allowZoomIn?, allowZoomOut?): Mat33

  • Computes and returns an affine transformation that makes toMakeVisible visible and roughly centered on the screen.

    Parameters

    • toMakeVisible: Rect2
    • allowZoomIn: boolean = true
    • allowZoomOut: boolean = true

    Returns Mat33

getResolution

getRotationAngle

  • getRotationAngle(): number

  • Returns number

    the angle of the canvas in radians. This is the angle by which the canvas is rotated relative to the screen.

    Returns an angle in the range [−π,π][-\pi, \pi] (the same range as Vec3.angle).

getScaleFactor

  • getScaleFactor(): number

  • Returns number

    the amount a vector on the canvas is scaled to become a vector on the screen.

getScaleFactorToNearestPowerOfTen

  • getScaleFactorToNearestPowerOfTen(): number

  • Returns number

    getScaleFactor() rounded to the nearest power of 10. For example, if getScaleFactor() returns 101, getScaleFactorToNearestPowerOfTen() should return 100 because 100 is the nearest power of 10 to 101.

getScreenRectSize

  • getScreenRectSize(): Vec3

  • Returns Vec3

    the size of the visible region in pixels (screen units).

getSizeOfPixelOnCanvas

  • getSizeOfPixelOnCanvas(): number

  • Returns the size of one screen pixel in canvas units.

    Returns number

getTemporaryClone

  • getTemporaryClone(): Viewport

  • Returns Viewport

    a temporary copy of this that does not notify when modified. This is useful when rendering with a temporarily different viewport.

resetTransform

  • resetTransform(newTransform?): void

  • Updates the transformation directly. Using transformBy is preferred.

    Parameters

    • newTransform: Mat33 = Mat33.identity

      should map from canvas coordinates to screen coordinates.

    Returns void

roundPoint

screenToCanvas

  • screenToCanvas(screenPoint): Vec3

  • Parameters

    Returns Vec3

    the given point, but in canvas coordinates

snapToGrid

zoomTo

  • zoomTo(toMakeVisible, allowZoomIn?, allowZoomOut?): Command

  • Returns a Command that transforms the view such that [rect] is visible, and perhaps centered in the viewport. Returns null if no transformation is necessary

    Parameters

    • toMakeVisible: Rect2
    • allowZoomIn: boolean = true
    • allowZoomOut: boolean = true

    Returns Command

    See

    computeZoomToTransform

Static getGridSize

  • getGridSize(scaleFactor): number

  • Returns the size of a grid cell (in canvas units) as used by snapToGrid.

    Parameters

    • scaleFactor: number

    Returns number

Static roundPoint

  • roundPoint<T>(point, tolerance): PointDataType<T>

  • Rounds the given point to a multiple of 10 such that it is within tolerance of its original location. This is useful for preparing data for base-10 conversion.

    Type Parameters

    • T extends number | Vec3

    Parameters

    • point: T
    • tolerance: number

    Returns PointDataType<T>

Static roundScaleRatio

  • roundScaleRatio(scaleRatio, roundAmount?): number

  • roundAmount: An integer >= 0, larger numbers cause less rounding. Smaller numbers cause more (as such roundAmount = 0 does the most rounding).

    Parameters

    • scaleRatio: number
    • roundAmount: number = 1

    Returns number

Static transformBy

  • transformBy(transform): ViewportTransform

  • Parameters

    Returns ViewportTransform

    a command that transforms the canvas by transform.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

OpenSource licenses