On this page

Billboard

Represents basic quad billboard image.

Constructor

new Billboard(optionsopt)

Parameters:

Name Type Attributes Description

options

Object

<optional>

Options:

Properties

Name	Type	Attributes	Description
`position`	Vec3 \| Array.<number>	<optional>	Billboard spatial position.
`rotation`	number	<optional>	Screen angle rotation.
`color`	Vec4 \| string \| Array.<number>	<optional>	Billboard color.
`alignedAxis`	Vec3 \| Array.<number>	<optional>	Billboard aligned vector.
`offset`	Vec3 \| Array.<number>	<optional>	Billboard center screen offset.
`visibility`	boolean	<optional>	Visibility.
`src`	string	<optional>	Billboard image url source.
`image`	Image	<optional>	Billboard image object.
`width`	number	<optional>	Screen width.
`height`	number	<optional>	Screen height.
`scale`	number	<optional>	Billboard scale.

Source: entity/Billboard.ts, line 13

Extends

BaseBillboard

Methods

getAlignedAxis() → {Vec3}

Returns aligned vector.

Overrides: BaseBillboard#getAlignedAxis
Source: entity/BaseBillboard.ts, line 365

Returns:

Type:: Vec3

getColor() → {Vec4}

Returns RGBA color.

Overrides: BaseBillboard#getColor
Source: entity/BaseBillboard.ts, line 304

Returns:

Type:: Vec4

getHeight() → {number}

Gets billboard screen height.

Source: entity/Billboard.ts, line 181

Returns:

Type:: number

getOffset() → {Vec3}

Returns billboard screen space offset size.

Overrides: BaseBillboard#getOffset
Source: entity/BaseBillboard.ts, line 214

Returns:

Type:: Vec3

getPosition() → {Vec3}

Returns billboard position.

Overrides: BaseBillboard#getPosition
Source: entity/BaseBillboard.ts, line 178

Returns:

Type:: Vec3

getRotation() → {number}

Gets screen space rotation.

Overrides: BaseBillboard#getRotation
Source: entity/BaseBillboard.ts, line 239

Returns:

Type:: number

getSize() → {Object}

Returns billboard screen size.

Source: entity/Billboard.ts, line 142

Returns:

Type:: Object

getVisibility() → {boolean}

Returns billboard visibility.

Overrides: BaseBillboard#getVisibility
Source: entity/BaseBillboard.ts, line 329

Returns:

Type:: boolean

getWidth() → {number}

Gets billboard screen width.

Source: entity/Billboard.ts, line 163

Returns:

Type:: number

remove()

Removes billboard from handler.

Overrides: BaseBillboard#remove
Source: entity/BaseBillboard.ts, line 374

setAlignedAxis(x, y, z)

Sets billboard cartesian aligned vector.

Parameters:

Name	Type	Description
`x`	number	Aligned vector X coordinate.
`y`	number	Aligned vector Y coordinate.
`z`	number	Aligned vector Z coordinate.

Overrides: BaseBillboard#setAlignedAxis
Source: entity/BaseBillboard.ts, line 338

setAlignedAxis3v(alignedAxis)

Sets billboard aligned vector.

Parameters:

Name	Type	Description
`alignedAxis`	Vec3	Align direction.

Overrides: BaseBillboard#setAlignedAxis3v
Source: entity/BaseBillboard.ts, line 356

setColor(r, g, b, a)

Sets RGBA color. Each channel from 0.0 to 1.0.

Parameters:

Name	Type	Description
`r`	number	Red.
`g`	number	Green.
`b`	number	Blue.
`a`	number	Alpha.

Overrides: BaseBillboard#setColor
Source: entity/BaseBillboard.ts, line 264

setColor4v(color)

Sets RGBA color. Each channel from 0.0 to 1.0.

Parameters:

Name	Type	Description
`color`	Vec4	RGBA vector.

Overrides: BaseBillboard#setColor4v
Source: entity/BaseBillboard.ts, line 286

setColorHTML(color)

Sets billboard color.

Parameters:

Name	Type	Description
`color`	string	HTML style color.

Overrides: BaseBillboard#setColorHTML
Source: entity/BaseBillboard.ts, line 295

setHeight(height)

Sets billboard screen heigh.

Parameters:

Name	Type	Description
`height`	number	Height.

Source: entity/Billboard.ts, line 172

setImage(image)

Sets image object.

Parameters:

Name	Type	Description
`image`	Object	JavaScript image object.

Source: entity/Billboard.ts, line 116

setOffset(x, y, zopt)

Sets screen space offset.

Parameters:

Name	Type	Attributes	Description
`x`	number		X offset.
`y`	number		Y offset.
`z`	number	<optional>	Z offset.

Overrides: BaseBillboard#setOffset
Source: entity/BaseBillboard.ts, line 187

setOffset3v(offset)

Sets screen space offset.

Parameters:

Name	Type	Description
`offset`	Vec2	Offset size.

Overrides: BaseBillboard#setOffset3v
Source: entity/BaseBillboard.ts, line 205

setOpacity(a)

Sets billboard opacity.

Parameters:

Name	Type	Description
`a`	number	Billboard opacity.

Overrides: BaseBillboard#setOpacity
Source: entity/BaseBillboard.ts, line 248

setPickingColor3v(color)

Sets billboard picking color.

Parameters:

Name	Type	Description
`color`	Vec3	Picking color.

Overrides: BaseBillboard#setPickingColor3v
Source: entity/BaseBillboard.ts, line 383

setPosition(x, y, z)

Sets billboard position.

Parameters:

Name	Type	Description
`x`	number	X coordinate.
`y`	number	Y coordinate.
`z`	number	Z coordinate.

Overrides: BaseBillboard#setPosition
Source: entity/BaseBillboard.ts, line 142

setPosition3v(position)

Sets billboard position.

Parameters:

Name	Type	Description
`position`	Vec3	Cartesian coordinates.

Overrides: BaseBillboard#setPosition3v
Source: entity/BaseBillboard.ts, line 161

setRotation(rotation)

Sets billboard screen space rotation in radians.

Parameters:

Name	Type	Description
`rotation`	number	Screen space rotation in radians.

Overrides: BaseBillboard#setRotation
Source: entity/BaseBillboard.ts, line 223

setSize(width, height)

Sets billboard screen size in pixels.

Parameters:

Name	Type	Description
`width`	number	Billboard width.
`height`	number	Billboard height.

Source: entity/Billboard.ts, line 129

setSrc(src)

Sets billboard image url source.

Parameters:

Name	Type	Description
`src`	string	Image url.

Source: entity/Billboard.ts, line 81

setVisibility(visibility)

Sets billboard visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Visibility flag.

Overrides: BaseBillboard#setVisibility
Source: entity/BaseBillboard.ts, line 313

setWidth(width)

Sets billboard screen width.

Parameters:

Name	Type	Description
`width`	number	Width.

Source: entity/Billboard.ts, line 154