BillboardMaterial
BillboardMaterial represents a material for billboard rendering.
Properties
Section titled “Properties”alphaTest
Section titled “alphaTest”Type: number | undefined
Description: Pixels with an RGBA alpha value below this threshold will not be rendered.
Default: undefined
Example:
{ billboard: { alphaTest: 0.5 }}center
Section titled “center”Type: Vec2
Description: Specifies the shift amount from the center. The range is between 0 and 1.
Default: Required
Example:
{ billboard: { center: { x: 0.5, y: 0.5 } }}clampToGround
Section titled “clampToGround”Type: boolean
Description: Specifies whether to clamp the billboard to the ground.
Default: Required
Example:
{ billboard: { clampToGround: true }}Type: Color
Description: Specifies the billboard color as a Color instance.
Default: Required
Example:
import { Color } from "@navaramap/three";
{ billboard: { color: new Color().setHex(0xffffff) }}declutter
Section titled “declutter”Type: boolean | undefined
Description: Participate in screen-space decluttering: when labels/sprites overlap on screen, lower-priority ones are hidden. Enabled by default; set to false to draw every label unconditionally.
Default: true
Example:
{ billboard: { declutter: false }}declutterPriority
Section titled “declutterPriority”Type: number | undefined
Description: Placement priority for decluttering; higher wins. Only meaningful when declutter is enabled. Can be overridden per feature via FeatureEvaluator.evaluate().
Default: 0.0
Example:
{ billboard: { declutter: true, declutterPriority: 1 }}depthTest
Section titled “depthTest”Type: boolean
Description: A variable that determines whether front-facing models occlude back-facing models.
Default: true
Example:
{ billboard: { depthTest: true }}effectIds
Section titled “effectIds”Type: string[] | undefined
Description: Specifies the IDs of selective effects to apply (e.g., “bloom”, “outline”). Used in conjunction with SelectiveBloomEffectDesc or SelectiveOutlineEffectDesc.
Default: undefined
Example:
{ billboard: { effectIds: ["bloom", "outline"] }}emissiveColor
Section titled “emissiveColor”Type: Color | undefined
Description: Specifies the emissive color as a Color instance.
Default: undefined
Example:
import { Color } from "@navaramap/three";
{ billboard: { emissiveColor: new Color().setHex(0xff0000) }}emissiveIntensity
Section titled “emissiveIntensity”Type: number | undefined
Description: Specifies the emissive intensity. The default value is 0.3 when the Bloom effect is enabled.
Default: undefined
Example:
{ billboard: { emissiveIntensity: 0.5 }}height
Section titled “height”Type: number
Description: Specifies the height of the billboard. The unit is meters.
Default: Required
Example:
{ billboard: { height: 100 // 100 meters }}offsetDepth
Section titled “offsetDepth”Type: boolean | undefined
Description: Avoids overlap with the earth’s surface. Use this to prevent the billboard from clipping into the earth’s surface.
Default: undefined
Example:
{ billboard: { offsetDepth: true }}opacity
Section titled “opacity”Type: number | undefined
Description: Specifies the opacity of the billboard. Valid range is 0.0 (fully transparent) to 1.0 (fully opaque).
Default: 1.0
Example:
{ billboard: { transparent: true, opacity: 0.5 // 50% opacity }}sizeInMeters
Section titled “sizeInMeters”Type: boolean | undefined
Description: Whether the size is specified in meters. If false, the size is in pixels.
Default: true
Example:
{ billboard: { sizeInMeters: true }}Type: boolean | undefined
Description: Specifies whether to show the billboard.
Default: undefined
Example:
{ billboard: { show: true }}Type: number
Description: Specifies the size of the billboard. The unit is meters.
Default: Required
Example:
{ billboard: { size: 10 // 10 meters }}transparent
Section titled “transparent”Type: boolean | undefined
Description: Specifies whether to consider the billboard’s transparency. Note that setting this to true may cause the billboard to not display correctly when effects are enabled.
Default: undefined
Example:
{ billboard: { transparent: false }}Type: string
Description: Specifies the URL of the object. Supports image files. This is the default image for every feature in the layer; individual features can override it by returning image from FeatureEvaluator.evaluate(), and returning image: null reverts an overridden feature to this default.
Default: Required
Example:
{ billboard: { url: "https://example.com/icons/marker.png" }}