TextCanvas | harp.gl

three.js text rendering engine which can manage and render high-quality, transformable, stylable and properly layout SDF and MSDF text.

Hierarchy

TextCanvas

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TextCanvas(params: TextCanvasParameters): TextCanvas

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:247
Constructs a new TextCanvas.

Parameters
- params: TextCanvasParameters
  
  TextCanvas construction parameters.
Returns TextCanvas

New TextCanvas.

Properties

Readonly maxGlyphCount

maxGlyphCount: number

Maximum amount of glyphs each TextCanvas layer can store.

Readonly minGlyphCount

minGlyphCount: number

Minimum amount of glyphs each TextCanvas layer can store.

Optional Readonly name

name: undefined | string

Accessors

backgroundMaterial

get backgroundMaterial(): Material
set backgroundMaterial(value: Material): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:361
Currently active text background rendering material.

Returns Material
- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:365
Currently active text background rendering material.

Parameters
- value: Material
Returns void

fontCatalog

get fontCatalog(): FontCatalog
set fontCatalog(value: FontCatalog): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:311
Currently active FontCatalog.

Returns FontCatalog
- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:315
Currently active FontCatalog.

Parameters
- value: FontCatalog
Returns void

material

get material(): Material
set material(value: Material): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:342
Currently active text rendering material.

Returns Material
- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:346
Currently active text rendering material.

Parameters
- value: Material
Returns void

textLayoutStyle

get textLayoutStyle(): TextLayoutStyle
set textLayoutStyle(style: TextLayoutStyle): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:391
Currently active text layout style.

Returns TextLayoutStyle
- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:395
Currently active text layout style.

Parameters
- style: TextLayoutStyle
Returns void

textRenderStyle

get textRenderStyle(): TextRenderStyle
set textRenderStyle(style: TextRenderStyle): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:380
Currently active text rendering style.

Returns TextRenderStyle
- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:384
Currently active text rendering style.

Parameters
- style: TextRenderStyle
Returns void

Methods

addLayer

addLayer(layerId: number): TextCanvasLayer

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:459
Creates a new TextCanvas rendering layer and returns. If there was already a layer for the input layerId, it just returns this one instead.

Parameters
- layerId: number
  
  Desired layer identifier.
Returns TextCanvasLayer

Created TextCanvasLayer.

addText

addText(text: string | GlyphData[], position: Vector3, params?: AdditionParameters): boolean

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:561
Adds the input text to this TextCanvas in the specified screen position. The current TextRenderStyle and TextLayoutStyle will influence the results of this function.

Parameters
- text: string | GlyphData[]
  
  Input text. Provide an array of GlyphData for better performance.
- position: Vector3
  
  Screen position.
- Optional params: AdditionParameters
  
  Optional addition parameters.
Returns boolean

Result of the addition. If false, some error occurred during execution and the input text couldn't be properly added.

addTextBufferObject

addTextBufferObject(textBufferObject: TextBufferObject, params?: TextBufferAdditionParameters): boolean

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:704
Adds a previously created TextBufferObject to the TextCanvas. Additional parameters can be provided to override the attributes stored in the buffer.

Parameters
- textBufferObject: TextBufferObject
  
  TextBufferObject to add.
- Optional params: TextBufferAdditionParameters
  
  Optional addition parameters.
Returns boolean

Result of the addition. If false, some error occurred during execution and the input text couldn't be properly added.

clear

clear(): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:402
Clears all the placed glyphs in this TextCanvas (as well as resetting the current style).

Returns void

createTextBufferObject

createTextBufferObject(text: string | GlyphData[], params?: TextBufferCreationParameters): TextBufferObject | undefined

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:625
Creates a new TextBufferObject. The computed text vertex buffer is equivalent to the result of performing the addText function for the input text in the screen origin.

Parameters
- text: string | GlyphData[]
  
  Input text. Provide an array of GlyphData for better performance.
- Optional params: TextBufferCreationParameters
  
  Optional creation parameters.
Returns TextBufferObject | undefined

New TextBufferObject (or undefined if requested text glyphs couldn't be retrieved from the current FontCatalog).

getAllLayers

getAllLayers(): TextCanvasLayer[]

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:497
Retrieves all TextCanvas rendering layers.

Returns TextCanvasLayer[]

Array of TextCanvasLayers.

getLayer

getLayer(layerId: number): TextCanvasLayer | undefined

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:488
Retrieves a specific TextCanvas rendering layer.

Parameters
- layerId: number
  
  Desired layer identifier.
Returns TextCanvasLayer | undefined

Selected TextCanvasLayer.

getMemoryUsage

getMemoryUsage(info: MemoryUsage): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:777
Update the info with the memory footprint caused by objects owned by the TextCanvas.

Parameters
- info: MemoryUsage
  
  The info object to increment with the values from this TextCanvas.
Returns void

measureText

measureText(text: string | GlyphData[], outputBounds: Box2, params?: MeasurementParameters): boolean

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:512
Returns the computed bounding box for the input text. The current TextRenderStyle and TextLayoutStyle will influence the results of this function.

Parameters
- text: string | GlyphData[]
  
  Input text. Provide an array of GlyphData for better performance.
- outputBounds: Box2
  
  Output text bounding box.
- Optional params: MeasurementParameters
  
  Optional measurement parameters.
Returns boolean

Result of the measurement. If false, some error occurred during execution and the input text couldn't be properly measured.

pickText

pickText(position: Vector2, callback: (pickData: any | undefined) => void): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:766
Executes the pickCallback for all previously stored picking data for text covering the specified screen position.

Parameters
- position: Vector2
- callback: (pickData: any | undefined) => void
  - - (pickData: any | undefined): void
    - Parameters
      - pickData: any | undefined
      Returns void
Returns void

render

render(camera: OrthographicCamera, lowerLayerId?: undefined | number, higherLayerId?: undefined | number, target?: THREE.WebGLRenderTarget, clear?: undefined | false | true): void

- Defined in @here/harp-text-canvas/lib/TextCanvas.ts:419
Renders the content of this TextCanvas.

Parameters
- camera: OrthographicCamera
  
  Orthographic camera.
- Optional lowerLayerId: undefined | number
  
  Optional Id the first layer to be rendered has to be equal or above
- Optional higherLayerId: undefined | number
  
  Optional Id the last layer to be rendered has to be below
- Optional target: THREE.WebGLRenderTarget
  
  Optional render target.
- Optional clear: undefined | false | true
  
  Optional render target clear operation.
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: TextCanvasParameters

Returns TextCanvas

Properties

Readonly maxGlyphCount

Readonly minGlyphCount

Optional Readonly name

Accessors

backgroundMaterial

Returns Material

Parameters

value: Material

Returns void

fontCatalog

Returns FontCatalog

Parameters

value: FontCatalog

Returns void

material

Returns Material

Parameters

value: Material

Returns void

textLayoutStyle

Returns TextLayoutStyle

Parameters

style: TextLayoutStyle

Returns void

textRenderStyle

Returns TextRenderStyle

Parameters

style: TextRenderStyle

Returns void

Methods

addLayer

Parameters

layerId: number

Returns TextCanvasLayer

addText

Parameters

text: string | GlyphData[]

position: Vector3

Optional params: AdditionParameters

Returns boolean

addTextBufferObject

Parameters

textBufferObject: TextBufferObject

Optional params: TextBufferAdditionParameters

Returns boolean

clear

Returns void

createTextBufferObject

Parameters

text: string | GlyphData[]

Optional params: TextBufferCreationParameters

Returns TextBufferObject | undefined

getAllLayers

Returns TextCanvasLayer[]

getLayer

Parameters

layerId: number

Returns TextCanvasLayer | undefined

getMemoryUsage

Parameters

info: MemoryUsage

Returns void

measureText

Parameters

text: string | GlyphData[]

outputBounds: Box2

Optional params: MeasurementParameters

Returns boolean