Class HtmlAnchorManager

Manager for mapping html elements to 3d positions in the scene.
Common use cases are:

  • Hotspot buttons: Interactively add/remove elements in the scene or just show some info on hovering
  • Input fields: Interactively change the size of an element
  • Info label: Just shows some information on a certain position within the scene

Html anchors are also used as dimension labels in the DimensionLineManager.

Hierarchy

  • HtmlAnchorManager

Methods

addHtmlAnchor removeAllHtmlAnchors removeHtmlAnchor

Methods

addHtmlAnchor

  • Assign a html element to a certain position in the scene.
    The html elements 2d position will be updated on each camera render, so that the element appears like a "normal" mesh within the scene.

    Parameters

    • name: string
    • htmlElement: HTMLElement
    • position: Vector3
    • Optional options: HtmlAnchorOptions

    Returns void

removeAllHtmlAnchors

  • Removes html anchor elements, as defined by the groups input

    Parameters

    • Optional groups: string[]

      if set, only html anchors which are part of these groups will be removed
      if left undefined, ALL html anchors will be removed

    Returns void

removeHtmlAnchor

  • Remove html anchor element and disposes all associated ressources

    Parameters

    • name: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc