Bitbybit Docs
    Preparing search index...

    Interface DrawnTag (Inputs.Draw)

    A drawn tag. Drawing a tag produces the tag itself rather than a mesh, because a tag is rendered as an HTML overlay positioned from the scene rather than as geometry in it. The drawing entry points still declare a mesh, which is the type every drawable output is described by, so a drawn tag reaches a caller through that declaration.

    interface DrawnTag {
        metadata?: DrawnTagMeta;
        text: string;
        position: Point3;
        colour: string;
        size: number;
        adaptDepth: boolean;
        needsUpdate?: boolean;
        id?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    metadata?: DrawnTagMeta
    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

    colour: string

    Hex color of the label's text

    size: number

    Font size of the label, in pixels

    adaptDepth: boolean

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

    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