Class TextElementsRenderer

Internal class to manage all text rendering.

Hierarchy

TextElementsRenderer

Constructors

constructor

new TextElementsRenderer(m_viewState, m_screenProjector, m_poiManager, m_renderer, m_imageCaches, options, textCanvasFactory?, poiRenderer?, screenCollisions?): TextElementsRenderer
Create the TextElementsRenderer which selects which labels should be placed on screen as a preprocessing step, which is not done every frame, and also renders the placed TextElements every frame.
Parameters
- m_viewState: ViewState
  
  State of the view for which this renderer will draw text.
- m_screenProjector: ScreenProjector
  
  Projects 3D coordinates into screen space.
- m_poiManager: PoiManager
  
  To prepare pois for rendering.
- m_renderer: WebGLRenderer
  
  The renderer to be used.
- m_imageCaches: MapViewImageCache[]
  
  The Image Caches to look for Icons.
- options: TextElementsRendererOptions
  
  Configuration options for the text renderer. See
- Optional textCanvasFactory: TextCanvasFactory
  
  Optional A TextCanvasFactory to override the default.
- Optional poiRenderer: PoiRenderer
  
  Optional A PoiRenderer to override the default.
- Optional screenCollisions: ScreenCollisions
  
  Optional ScreenCollisions to override the default. [[TextElementsRendererOptions]].
Returns TextElementsRenderer
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:388

Accessors

delayLabelsUntilMovementFinished

get delayLabelsUntilMovementFinished(): boolean
Returns boolean
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:443
set delayLabelsUntilMovementFinished(delay): void
Parameters
- delay: boolean
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:447

disableFading

get disableFading(): boolean
Returns boolean
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:435
set disableFading(disable): void
Disable all fading animations (for debugging and performance measurement). Defaults to false.
Parameters
- disable: boolean
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:431

isUpdatePending

get isUpdatePending(): boolean
true if TextElements are not placed finally but are still updating, including fading or waiting for elevation.

Returns boolean
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:741

loading

get loading(): boolean
true if any resource used by any FontCatalog is still loading.

Returns boolean
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:733

overlayText

get overlayText(): undefined | TextElement[]
Returns undefined | TextElement[]
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:683

overloaded

get overloaded(): boolean
Is true if number of TextElements in visible tiles is larger than the recommended number OVERLOAD_LABEL_LIMIT.

Returns boolean
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:592

showReplacementGlyphs

get showReplacementGlyphs(): boolean
If true, a replacement glyph ("?") is rendered for every missing glyph.

Returns boolean
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:454
set showReplacementGlyphs(value): void
If true, a replacement glyph ("?") is rendered for every missing glyph.
Parameters
- value: boolean
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:461

styleCache

get styleCache(): TextStyleCache
Returns TextStyleCache
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:439

Methods

addOverlayText

addOverlayText(textElements): void
Adds new overlay text elements to this MapView.
Parameters
- textElements: TextElement[]
  
  Array of TextElement to be added.
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:657

clearOverlayText

clearOverlayText(): void
Adds new overlay text elements to this MapView.

Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:672

clearRenderStates

clearRenderStates(): void
Reset the current text render states of all visible tiles.

Returns void

Remarks
All TextElements will fade in after that as if they have just been added.
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:761

getMemoryUsage

getMemoryUsage(): MemoryUsage
Return memory used by all objects managed by TextElementsRenderer.

Returns MemoryUsage
MemoryUsage Heap and GPU memory used by this TextElementsRenderer.
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:770

hasOverlayText

hasOverlayText(): boolean
Returns boolean
Whether there's overlay text to be rendered.
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:679

invalidateCache

invalidateCache(): void
Forces update of text elements in the next call to [[placeText]].

Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:565

movementFinished

movementFinished(): void
Notify TextElementsRenderer that the camera has finished its movement.

Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:581

movementStarted

movementStarted(): void
Notify TextElementsRenderer that the camera has started a movement.

Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:572

pickTextElements

pickTextElements(screenPosition, pickListener): void
Fill the picking results for the pixel with the given screen coordinate. If multiple TextElements are found, the order of the results is unspecified.

Note: TextElements with identical featureId or identical userData will only appear once in the list pickResults.
Parameters
- screenPosition: Vector2
  
  Screen coordinate of picking position.
- pickListener: PickListener
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:698

placeText

placeText(dataSourceTileList, time): void
Places text elements for the current frame.
Parameters
- dataSourceTileList: DataSourceTileList[]
  
  List of tiles to be rendered for each data source.
- time: number
  
  Current frame time.
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:601

renderText

renderText(farPlane): void
Render the text using the specified camera into the current canvas.
Parameters
- farPlane: number
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:544

restoreRenderers

restoreRenderers(renderer): void
Parameters
- renderer: WebGLRenderer
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:471

updateCamera

updateCamera(): void
Returns void
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:1087

updateFontCatalogs

updateFontCatalogs(fontCatalogs?): Promise<void>
Updates the FontCatalogs used by this TextElementsRenderer.
Parameters
- Optional fontCatalogs: FontCatalogConfig[]
  
  The new list of FontCatalogConfigs
Returns Promise<void>
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:486

updateTextStyles

updateTextStyles(textStyles?, defaultTextStyle?): Promise<void>
Parameters
- Optional textStyles: TextStyleDefinition[]
- Optional defaultTextStyle: TextStyleDefinition
Returns Promise<void>
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:529

waitLoaded

waitLoaded(): Promise<void>
Waits till all pending resources from any FontCatalog are loaded.

Returns Promise<void>
- Defined in @xyzmaps/harp-mapview/lib/text/TextElementsRenderer.ts:748

Class TextElementsRenderer

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

m_viewState: ViewState

m_screenProjector: ScreenProjector

m_poiManager: PoiManager

m_renderer: WebGLRenderer

m_imageCaches: MapViewImageCache[]

options: TextElementsRendererOptions

Optional textCanvasFactory: TextCanvasFactory

Optional poiRenderer: PoiRenderer

Optional screenCollisions: ScreenCollisions

Returns TextElementsRenderer

Accessors

delayLabelsUntilMovementFinished

Returns boolean

Parameters

delay: boolean

Returns void

disableFading

Returns boolean

Parameters

disable: boolean

Returns void

isUpdatePending

Returns boolean

loading

Returns boolean

overlayText

Returns undefined | TextElement[]

overloaded

Returns boolean

showReplacementGlyphs

Returns boolean

Parameters

value: boolean

Returns void

styleCache

Returns TextStyleCache

Methods

addOverlayText

Parameters

textElements: TextElement[]

Returns void

clearOverlayText

Returns void

clearRenderStates

Returns void

Remarks

getMemoryUsage

Returns MemoryUsage

hasOverlayText

Returns boolean

invalidateCache

Returns void

movementFinished

Returns void

movementStarted

Returns void

pickTextElements

Parameters

screenPosition: Vector2

pickListener: PickListener

Returns void

placeText

Parameters

dataSourceTileList: DataSourceTileList[]

time: number

Returns void

renderText

Parameters

farPlane: number

Returns void

restoreRenderers

`Optional` textCanvasFactory: TextCanvasFactory

`Optional` poiRenderer: PoiRenderer

`Optional` screenCollisions: ScreenCollisions

`Optional` fontCatalogs: FontCatalogConfig[]

`Optional` textStyles: TextStyleDefinition[]

`Optional` defaultTextStyle: TextStyleDefinition