BaseBillboard

Source: BaseBillboard.ts:32

Base prototype for billboard and label classes.

Constructor

Parameters

• options (Object, optional) — Options:
  • options.position (Vec3 | Array.<number>, optional) — Billboard position.
  • options.rotation (number, optional) — Screen angle rotation.
  • options.color (Vec4 | string | Array.<number>, optional) — Billboard color.
  • options.alignedAxis (Vec3 | Array.<number>, optional) — Billboard aligned vector.
  • options.offset (Vec2 | Array.<number>, optional) — Billboard center screen offset.
  • options.visibility (boolean, optional) — Visibility.

Instance Methods

setPosition(x: number, y: number, z: number)

Sets billboard position.

Parameters

• x (number) — X coordinate.
• y (number) — Y coordinate.
• z (number) — Z coordinate.

setPosition3v(position: Vec3)

Sets billboard position.

Parameters

• position (Vec3) — Cartesian coordinates.

getPosition(): Vec3

Returns billboard position.

Returns

• Vec3

setOffset(x: number, y: number)

Sets screen space offset.

Parameters

• x (number) — X offset.
• y (number) — Y offset.

setOffset2v(offset: Vec2)

Sets screen space offset.

Parameters

• offset (Vec2) — Offset size.

getOffset(): Vec2

Returns billboard screen space offset size.

Returns

• Vec2

setRotation(rotation: number)

Sets billboard screen space rotation in radians.

Parameters

• rotation (number) — Screen space rotation in radians.

getRotation(): number

Gets screen space rotation.

Returns

• number

setOpacity(a: number)

Sets billboard opacity.

Parameters

• a (number) — Billboard opacity.

setColor(r: number, g: number, b: number, a: number)

Sets RGBA color. Each channel from 0.0 to 1.0.

Parameters

• r (number) — Red.
• g (number) — Green.
• b (number) — Blue.
• a (number) — Alpha.

setColor4v(color: Vec4)

Sets RGBA color. Each channel from 0.0 to 1.0.

Parameters

• color (Vec4) — RGBA vector.

setColorHTML(color: string)

Sets billboard color.

Parameters

• color (string) — HTML style color.

getColor(): Vec4

Returns RGBA color.

Returns

• Vec4

setVisibility(visibility: boolean)

Sets billboard visibility.

Parameters

• visibility (boolean) — Visibility flag.

getVisibility(): boolean

Returns billboard visibility.

Returns

• boolean

setAlignedAxis(x: number, y: number, z: number)

Sets billboard cartesian aligned vector.

Parameters

• x (number) — Aligned vector X coordinate.
• y (number) — Aligned vector Y coordinate.
• z (number) — Aligned vector Z coordinate.

setAlignedAxis3v(alignedAxis: Vec3)

Sets billboard aligned vector.

Parameters

• alignedAxis (Vec3) — Align direction.

getAlignedAxis(): Vec3

Returns aligned vector.

Returns

• Vec3

remove()

Removes billboard from handler.

setPickingColor3v(color: Vec3)

Sets billboard picking color.

Parameters

• color (Vec3) — Picking color.