On this page

BaseBillboard

Base prototype for billboard and label classes.

Constructor

new BaseBillboard(optionsopt)

Parameters:

Name Type Attributes Description

options

Object

<optional>

Options:

Properties

Name	Type	Attributes	Description
`position`	Vec3 \| Array.<number>	<optional>	Billboard 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.

Source: entity/BaseBillboard.ts, line 18

Methods

getAlignedAxis() → {Vec3}

Returns aligned vector.

Source: entity/BaseBillboard.ts, line 365

Returns:

Type:: Vec3

getColor() → {Vec4}

Returns RGBA color.

Source: entity/BaseBillboard.ts, line 304

Returns:

Type:: Vec4

getOffset() → {Vec3}

Returns billboard screen space offset size.

Source: entity/BaseBillboard.ts, line 214

Returns:

Type:: Vec3

getPosition() → {Vec3}

Returns billboard position.

Source: entity/BaseBillboard.ts, line 178

Returns:

Type:: Vec3

getRotation() → {number}

Gets screen space rotation.

Source: entity/BaseBillboard.ts, line 239

Returns:

Type:: number

getVisibility() → {boolean}

Returns billboard visibility.

Source: entity/BaseBillboard.ts, line 329

Returns:

Type:: boolean

remove()

Removes billboard from handler.

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.

Source: entity/BaseBillboard.ts, line 338

setAlignedAxis3v(alignedAxis)

Sets billboard aligned vector.

Parameters:

Name	Type	Description
`alignedAxis`	Vec3	Align direction.

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.

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.

Source: entity/BaseBillboard.ts, line 286

setColorHTML(color)

Sets billboard color.

Parameters:

Name	Type	Description
`color`	string	HTML style color.

Source: entity/BaseBillboard.ts, line 295

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.

Source: entity/BaseBillboard.ts, line 187

setOffset3v(offset)

Sets screen space offset.

Parameters:

Name	Type	Description
`offset`	Vec2	Offset size.

Source: entity/BaseBillboard.ts, line 205

setOpacity(a)

Sets billboard opacity.

Parameters:

Name	Type	Description
`a`	number	Billboard opacity.

Source: entity/BaseBillboard.ts, line 248

setPickingColor3v(color)

Sets billboard picking color.

Parameters:

Name	Type	Description
`color`	Vec3	Picking color.

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.

Source: entity/BaseBillboard.ts, line 142

setPosition3v(position)

Sets billboard position.

Parameters:

Name	Type	Description
`position`	Vec3	Cartesian coordinates.

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.

Source: entity/BaseBillboard.ts, line 223

setVisibility(visibility)

Sets billboard visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Visibility flag.

Source: entity/BaseBillboard.ts, line 313