Billboard

Extends: BaseBillboard

Source: Billboard.ts:34

Represents basic quad billboard image.

Constructor

Parameters

• options (Object, optional) — Options:
  • options.position (Vec3 | Array.<number>, optional) — Billboard spatial 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.
  • options.src (string, optional) — Billboard image url source.
  • options.image (Image, optional) — Billboard image object.
  • options.width (number, optional) — Screen width.
  • options.height (number, optional) — Screen height.
  • options.scale (number, optional) — Billboard scale.

Instance Methods

setSrc(src: string)

Sets billboard image url source.

Parameters

• src (string) — Image url.

setImage(image: Object)

Sets image object.

Parameters

• image (Object) — JavaScript image object.

setSize(width: number, height: number)

Sets billboard screen size in pixels.

Parameters

• width (number) — Billboard width.
• height (number) — Billboard height.

getSize(): Object

Returns billboard screen size.

Returns

• Object

setWidth(width: number)

Sets billboard screen width.

Parameters

• width (number) — Width.

getWidth(): number

Gets billboard screen width.

Returns

• number

setHeight(height: number)

Sets billboard screen heigh.

Parameters

• height (number) — Height.

getHeight(): number

Gets billboard screen height.

Returns

• number

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

Inherited from BaseBillboard#setPosition

Overrides: BaseBillboard#setPosition

Sets billboard position.

Parameters

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

setPosition3v(position: Vec3)

Inherited from BaseBillboard#setPosition3v

Overrides: BaseBillboard#setPosition3v

Sets billboard position.

Parameters

• position (Vec3) — Cartesian coordinates.

getPosition(): Vec3

Inherited from BaseBillboard#getPosition

Overrides: BaseBillboard#getPosition

Returns billboard position.

Returns

• Vec3

setOffset(x: number, y: number)

Inherited from BaseBillboard#setOffset

Overrides: BaseBillboard#setOffset

Sets screen space offset.

Parameters

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

setOffset2v(offset: Vec2)

Inherited from BaseBillboard#setOffset2v

Overrides: BaseBillboard#setOffset2v

Sets screen space offset.

Parameters

• offset (Vec2) — Offset size.

getOffset(): Vec2

Inherited from BaseBillboard#getOffset

Overrides: BaseBillboard#getOffset

Returns billboard screen space offset size.

Returns

• Vec2

setRotation(rotation: number)

Inherited from BaseBillboard#setRotation

Overrides: BaseBillboard#setRotation

Sets billboard screen space rotation in radians.

Parameters

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

getRotation(): number

Inherited from BaseBillboard#getRotation

Overrides: BaseBillboard#getRotation

Gets screen space rotation.

Returns

• number

setOpacity(a: number)

Inherited from BaseBillboard#setOpacity

Overrides: BaseBillboard#setOpacity

Sets billboard opacity.

Parameters

• a (number) — Billboard opacity.

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

Inherited from BaseBillboard#setColor

Overrides: BaseBillboard#setColor

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)

Inherited from BaseBillboard#setColor4v

Overrides: BaseBillboard#setColor4v

Sets RGBA color. Each channel from 0.0 to 1.0.

Parameters

• color (Vec4) — RGBA vector.

setColorHTML(color: string)

Inherited from BaseBillboard#setColorHTML

Overrides: BaseBillboard#setColorHTML

Sets billboard color.

Parameters

• color (string) — HTML style color.

getColor(): Vec4

Inherited from BaseBillboard#getColor

Overrides: BaseBillboard#getColor

Returns RGBA color.

Returns

• Vec4

setVisibility(visibility: boolean)

Inherited from BaseBillboard#setVisibility

Overrides: BaseBillboard#setVisibility

Sets billboard visibility.

Parameters

• visibility (boolean) — Visibility flag.

getVisibility(): boolean

Inherited from BaseBillboard#getVisibility

Overrides: BaseBillboard#getVisibility

Returns billboard visibility.

Returns

• boolean

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

Inherited from BaseBillboard#setAlignedAxis

Overrides: BaseBillboard#setAlignedAxis

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)

Inherited from BaseBillboard#setAlignedAxis3v

Overrides: BaseBillboard#setAlignedAxis3v

Sets billboard aligned vector.

Parameters

• alignedAxis (Vec3) — Align direction.

getAlignedAxis(): Vec3

Inherited from BaseBillboard#getAlignedAxis

Overrides: BaseBillboard#getAlignedAxis

Returns aligned vector.

Returns

• Vec3

remove()

Inherited from BaseBillboard#remove

Overrides: BaseBillboard#remove

Removes billboard from handler.

setPickingColor3v(color: Vec3)

Inherited from BaseBillboard#setPickingColor3v

Overrides: BaseBillboard#setPickingColor3v

Sets billboard picking color.

Parameters

• color (Vec3) — Picking color.