Bitbybit Docs
    Preparing search index...

    Class PointOfInterestStyleDto (Advanced.Navigation)

    Look of a point of interest, built by advanced.navigation.pointOfInterestStyle and passed as style. Sizes are in hundredths of a model unit, and with stableSize they hold steady on screen.

    Index

    Constructors

    constructor

    Properties

    pointSize? pointColor? hoverPointColor? pulseColor? hoverPulseColor? pulseMinSize? pulseMaxSize? pulseThickness? pulseSpeed? textColor? hoverTextColor? textSize? textFontWeight? textBackgroundColor? textBackgroundOpacity textBackgroundStroke textBackgroundStrokeThickness textBackgroundRadius textPosition stableSize alwaysOnTop

    Constructors

    • Parameters

      • OptionalpointSize: number
      • OptionalpointColor: string
      • OptionalhoverPointColor: string
      • OptionalpulseColor: string
      • OptionalpulseMinSize: number
      • OptionalpulseMaxSize: number
      • OptionalpulseThickness: number
      • OptionalpulseSpeed: number
      • OptionaltextColor: string
      • OptionalhoverTextColor: string
      • OptionaltextSize: number
      • OptionaltextFontWeight: number
      • OptionaltextBackgroundColor: string
      • OptionaltextBackgroundOpacity: number
      • OptionaltextBackgroundStroke: boolean
      • OptionaltextBackgroundStrokeThickness: number
      • OptionaltextBackgroundRadius: number
      • OptionaltextPosition: topBottomEnum
      • OptionalstableSize: boolean
      • OptionalalwaysOnTop: boolean

      Returns PointOfInterestStyleDto

    Properties

    pointSize?: number

    Diameter of the solid center sphere in hundredths of a model unit, so 20 is 0.2 units. With stableSize that is its size seen from 10 units away.

    20
    pointColor?: string

    Color of the center sphere, drawn unlit.

    #ffffff
    hoverPointColor?: string

    Color of the center sphere while the pointer is over the marker; the sphere also grows by a fifth.

    #0000ff
    pulseColor?: string

    Color of the ring that pulses around the point, drawn at most 30 percent opaque.

    #ffffff
    hoverPulseColor?: string

    Color of the pulsing ring while the pointer is over the marker.

    #0000ff
    pulseMinSize?: number

    Diameter the ring starts each pulse at, in hundredths of a model unit.

    20
    pulseMaxSize?: number

    Diameter the ring grows to as it fades, in hundredths of a model unit. It is also the size of the invisible sphere that catches hovers and clicks.

    50
    pulseThickness?: number

    Thickness of the ring in hundredths of a model unit; 0 falls back to 10.

    2
    pulseSpeed?: number

    How fast the ring pulses: one grow-and-shrink cycle lasts 2 pi divided by this value, in seconds, so 3 gives about two seconds.

    3
    textColor?: string

    Color of the label text, and of the outline around its background when textBackgroundStroke is set.

    #ffffff
    hoverTextColor?: string

    Color of the label text while the pointer is over the marker.

    #0000ff
    textSize?: number

    Label size: 16 makes the label plane 0.3 model units tall before stableSize scaling, and the plane scales in proportion.

    14
    textFontWeight?: number

    Weight of the label's Arial font, as in CSS: 400 is regular and 700 bold.

    400

    100

    900

    100

    textBackgroundColor?: string

    Fill color behind the label; it shows only when textBackgroundOpacity is above 0.

    #000000
    textBackgroundOpacity: number

    Opacity of the label background, from 0 for none to 1 for solid. The default 0 shows no background.

    0.0

    0

    1

    0.1

    textBackgroundStroke: boolean

    Draws an outline in the text color around the label background, whatever its opacity.

    false
    textBackgroundStrokeThickness: number

    Width of the background outline in pixels of the label's texture, on which the text is eight times textSize pixels tall.

    8

    1

    20

    1

    textBackgroundRadius: number

    Corner radius of the label background in pixels of the label's texture, on which the text is eight times textSize pixels tall.

    40

    0

    100

    5

    textPosition: topBottomEnum

    Whether the label sits above or below the marker as seen from the camera; it is moved every frame to stay there.

    bottom
    stableSize: boolean

    Rescales the marker and its label every frame by their camera distance divided by 10, never below 0.1, so they keep the size they have 10 model units away.

    true
    alwaysOnTop: boolean

    Draws the sphere, the ring and the label over other geometry instead of letting it hide them.

    false

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties