Class AbstractRenderer`Abstract`

Abstract base class for renderers.

See

EditorImage.render

Hierarchy (View Summary)

AbstractRenderer

Constructors

`Protected`constructor

new AbstractRenderer(viewport: Viewport): AbstractRenderer
Parameters
- viewport: Viewport
Returns AbstractRenderer
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:36

Properties

`Protected`objectLevel

objectLevel: number = 0

Methods

`Protected` `Abstract`beginPath

beginPath(startPoint: Vec3): void
Parameters
- startPoint: Vec3
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:52

canRenderFromWithoutDataLoss

canRenderFromWithoutDataLoss(_other: AbstractRenderer): boolean
Returns true iff other can be rendered onto this without data loss.
Parameters
- _other: AbstractRenderer
Returns boolean
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:191

canvasToScreen

canvasToScreen(vec: Vec3): Vec3
Parameters
- vec: Vec3
Returns Vec3
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:228

`Abstract`clear

clear(): void
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:51

`Abstract`displaySize

displaySize(): Vec3
Returns the size of the rendered region of this on the display (in pixels).

Returns Vec3
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:49

`Abstract`drawImage

drawImage(image: RenderableImage): void
Parameters
- image: RenderableImage
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:59

drawPath

drawPath(path: RenderablePathSpec): void
Draws a styled path. If within an object started by startObject, the resultant path may not be visible until endObject is called.
Parameters
- path: RenderablePathSpec
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:117

`Abstract`drawPoints

drawPoints(...points: Vec3[]): void
Draw a representation of [points]. Intended for debugging.
Parameters
- ...points: Vec3[]
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:188

drawRect

drawRect(rect: Rect2, lineWidth: number, lineFill: RenderingStyle): void
Strokes a rectangle. Boundary lines have width [lineWidth] and are filled with [lineFill]. This is equivalent to drawPath(Path.fromRect(...).toRenderable(...)).
Parameters
- rect: Rect2
- lineWidth: number
- lineFill: RenderingStyle
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:133

`Abstract`drawText

drawText(text: string, transform: Mat33, style: TextRenderingStyle): void
Parameters
- text: string
- transform: Mat33
- style: TextRenderingStyle
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:58

endObject

endObject(_loaderData?: LoadSaveDataTable, _objectTags?: string[]): void
Notes the end of an object.
Parameters
- Optional_loaderData: LoadSaveDataTable
  a map from strings to JSON-ifyable objects and contains properties attached to the object by whatever loader loaded the image. This is used to preserve attributes not supported by js-draw when loading/saving an image. Renderers may ignore this.
- Optional_objectTags: string[]
  a list of labels (e.g. classNames) to be attached to the object. Renderers may ignore this.
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:170

`Protected` `Abstract`endPath

endPath(style: RenderingStyle): void
Parameters
- style: RenderingStyle
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:53

fillRect

fillRect(rect: Rect2, fill: Color4): void
Draws a filled rectangle.
Parameters
- rect: Rect2
- fill: Color4
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:139

getCanvasToScreenTransform

getCanvasToScreenTransform(): Mat33
Get the matrix that transforms a vector on the canvas to a vector on this' rendering target.

Returns Mat33
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:221

`Protected`getNestingLevel

getNestingLevel(): number
Returns number
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:183

getSizeOfCanvasPixelOnScreen

getSizeOfCanvasPixelOnScreen(): number
Returns number
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:232

`Protected`getViewport

getViewport(): Viewport
this.canvasToScreen, etc. should be used instead of the corresponding methods on Viewport, because the viewport may not accurately reflect what is rendered.

Returns Viewport
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:43

getVisibleRect

getVisibleRect(): Rect2
Returns the region in canvas space that is visible within the viewport this canvas is rendering to.

Note that in some cases this might not be the same as the visibleRect given to components in their render method.

Returns Rect2
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:250

`Abstract`isTooSmallToRender

isTooSmallToRender(rect: Rect2): boolean
Returns true iff the given rectangle is so small, rendering anything within it has no effect on the image.
Parameters
- rect: Rect2
Returns boolean
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:63

`Protected` `Abstract`lineTo

lineTo(point: Vec3): void
Parameters
- point: Vec3
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:54

`Protected` `Abstract`moveTo

moveTo(point: Vec3): void
Parameters
- point: Vec3
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:55

popTransform

popTransform(): void
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:211

pushTransform

pushTransform(transform: Mat33): void
Parameters
- transform: Mat33
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:206

renderFromOtherOfSameType

renderFromOtherOfSameType(_renderTo: Mat33, other: AbstractRenderer): void
MUST throw if other and this are not of the same base class.
Parameters
- _renderTo: Mat33
- other: AbstractRenderer
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:196

setDraftMode

setDraftMode(_draftMode: boolean): void
Parameters
- _draftMode: boolean
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:65

setTransform

setTransform(transform: null | Mat33): void
Set a transformation to apply to things before rendering, replacing the viewport's transform.
Parameters
- transform: null | Mat33
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:202

startObject

startObject(_boundingBox: Rect2, _clip?: boolean): void
This should be called whenever a new object is being drawn.
Parameters
- _boundingBox: Rect2
  The bounding box of the object to be drawn.
- Optional_clip: boolean
  Whether content outside _boundingBox should be drawn. Renderers that override this method are not required to support _clip.
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:151

`Protected` `Abstract`traceCubicBezierCurve

traceCubicBezierCurve(p1: Vec3, p2: Vec3, p3: Vec3): void
Parameters
- p1: Vec3
- p2: Vec3
- p3: Vec3
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:56

`Protected` `Abstract`traceQuadraticBezierCurve

traceQuadraticBezierCurve(controlPoint: Vec3, endPoint: Vec3): void
Parameters
- controlPoint: Vec3
- endPoint: Vec3
Returns void
- Defined in js-draw/src/rendering/renderers/AbstractRenderer.ts:57

Class AbstractRendererAbstract

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns AbstractRenderer

Properties

ProtectedobjectLevel

Methods

Protected AbstractbeginPath

Parameters

Returns void

canRenderFromWithoutDataLoss

Parameters

Returns boolean

canvasToScreen

Parameters

Returns Vec3

Abstractclear

Returns void

AbstractdisplaySize

Returns Vec3

AbstractdrawImage

Parameters

Returns void

drawPath

Parameters

Returns void

AbstractdrawPoints

Parameters

Returns void

drawRect

Parameters

Returns void

AbstractdrawText

Parameters

Returns void

endObject

Parameters

Returns void

Protected AbstractendPath

Parameters

Returns void

fillRect

Parameters

Returns void

getCanvasToScreenTransform

Returns Mat33

ProtectedgetNestingLevel

Returns number

getSizeOfCanvasPixelOnScreen

Returns number

ProtectedgetViewport

Returns Viewport

getVisibleRect

Returns Rect2

AbstractisTooSmallToRender

Parameters

Returns boolean

Protected AbstractlineTo

Parameters

Returns void

Protected AbstractmoveTo

Parameters

Returns void

popTransform

Returns void

pushTransform

Parameters

Returns void

renderFromOtherOfSameType

Parameters

Returns void

setDraftMode

Parameters

Class AbstractRenderer`Abstract`

`Protected`constructor

`Protected`objectLevel

`Protected` `Abstract`beginPath

`Abstract`clear

`Abstract`displaySize

`Abstract`drawImage

`Abstract`drawPoints

`Abstract`drawText

`Protected` `Abstract`endPath

`Protected`getNestingLevel

`Protected`getViewport

`Abstract`isTooSmallToRender

`Protected` `Abstract`lineTo

`Protected` `Abstract`moveTo

`Protected` `Abstract`traceCubicBezierCurve

`Protected` `Abstract`traceQuadraticBezierCurve