Type alias HtmlAnchorOptions

HtmlAnchorOptions: { enablePointerEvents?: boolean; group?: string; hideIfOccluded?: boolean; parentNode?: TransformNode; scaleWithCameraDistance?: boolean }

Type declaration

  • Optional enablePointerEvents?: boolean

    Activates/deactivates pointer-events CSS class of anchor element.
    Set this to true if the html element should be interactive (e.g. button)

    Default: false

  • Optional group?: string

    Can be used to filter affected html anchors in removeAllHtmlAnchors

  • Optional hideIfOccluded?: boolean

    true: html elements can be occluded by other meshes false: html elements will always be shown in front of the scene

    Default: false

  • Optional parentNode?: TransformNode

    Associated anchor mesh will be created underneath this parent node.
    Can be used to make anchor position calculation easier in nested scene structures.

  • Optional scaleWithCameraDistance?: boolean

    true: html element size is relative to camera distance, just like a "normal" 3d object false: html element size remains constant

    Default: false

Generated using TypeDoc