Bitbybit Docs
    Preparing search index...

    Class TagDto (Inputs.Tag)

    A text label pinned to a 3D position, as tag.create builds it and tag.drawTag shows it: the text, where it sits, its color and size, and whether it shrinks with distance. id and needsUpdate are filled in by drawing.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    text position? colour? size? adaptDepth? needsUpdate? id?

    Constructors

    • Parameters

      • Optionaltext: string
      • Optionalposition: Point3
      • Optionalcolour: string
      • Optionalsize: number
      • OptionaladaptDepth: boolean
      • OptionalneedsUpdate: boolean
      • Optionalid: string

      Returns TagDto

    Properties

    text

    text: string

    The label's content, shown as plain text

    position?: Point3

    The point in the scene the label is pinned to; it stays over that point as the camera moves

    [0, 0, 0]
    colour?: string

    Hex color of the label's text

    #444444
    size?: number

    Font size of the label, in pixels

    12
    adaptDepth?: boolean

    When true, a label far from the camera is drawn smaller than one nearby, as if it sat in the scene

    false
    needsUpdate?: boolean

    Set by drawing to ask for a refresh of the label on the next frame; not something to set by hand

    true

    id?: string

    Identifier given to the label when it is drawn, which later updates use to find it; not something to set by hand

    true

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties