Class: BaseBillboard

Members

protected_alignedAxisVec3

Cartesian aligned axis vector.

protected_colorVec4

RGBA color.

protected_entityEntity

Entity instance that holds this billboard.

protected_handlerBillboardHandler

Handler that stores and renders this billboard object.

protected_handlerIndexnumber

Billboard handler array index.

protected_isReadynumber

An indication that the object is ready to draw

protected_offsetmath.Vecto3

Billboard center screen space offset. Where x,y - screen space offset and z - depth offset.

protected_positionVec3

Billboard center cartesian position.

protected_rotationnumber

Screen space rotation angle.

protected_visibilityboolean

Billboard visibility.

readonlyidnumber

Object unic identifier.

Methods

getAlignedAxis(){Vec3}

og/entity/BaseBillboard.js, line 352

Returns aligned vector.

Returns:

Type	Description
Vec3

getColor(){Vec4}

og/entity/BaseBillboard.js, line 291

Returns RGBA color.

Returns:

Type	Description
Vec4

getOffset(){Vec3}

og/entity/BaseBillboard.js, line 201

Returns billboard screen space offset size.

Returns:

Type	Description
Vec3

getPosition(){Vec3}

og/entity/BaseBillboard.js, line 165

Returns billboard position.

Returns:

Type	Description
Vec3

getRotation(){number}

og/entity/BaseBillboard.js, line 226

Gets screen space rotation.

Returns:

Type	Description
number

getVisibility(){boolean}

og/entity/BaseBillboard.js, line 316

Returns billboard visibility.

Returns:

Type	Description
boolean

remove()

og/entity/BaseBillboard.js, line 360

Removes billboard from hander.

setAlignedAxis(x, y, z)

og/entity/BaseBillboard.js, line 327

Sets billboard cartesian aligned vector.

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

setAlignedAxis3v(alignedAxis)

og/entity/BaseBillboard.js, line 343

Sets billboard aligned vector.

Name	Type	Description
alignedAxis	math.Vecto3	Vector to align.

setColor(r, g, b, a)

og/entity/BaseBillboard.js, line 254

Sets RGBA color. Each channel from 0.0 to 1.0.

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

setColor4v(color)

og/entity/BaseBillboard.js, line 273

Sets RGBA color. Each channel from 0.0 to 1.0.

Name	Type	Description
color	Vec4	RGBA vector.

setColorHTML(color)

og/entity/BaseBillboard.js, line 282

Sets billboard color.

Name	Type	Description
color	string	HTML style color.

setOffset(x, y, z)

og/entity/BaseBillboard.js, line 176

Sets screen space offset.

Name	Type	Description
x	number	X offset.
y	number	Y offset.
z	number	optional Z offset.

setOffset3v(offset)

og/entity/BaseBillboard.js, line 192

Sets screen space offset.

Name	Type	Description
offset	Vec2	Offset size.

setOpacity(a)

og/entity/BaseBillboard.js, line 235

Sets billboard opacity.

Name	Type	Description
a	number	Billboard opacity.

setPickingColor3v(color)

og/entity/BaseBillboard.js, line 370

Sets billboard picking color.

Name	Type	Description
color	Vec3	Picking color.

setPosition(x, y, z)

og/entity/BaseBillboard.js, line 131

Sets billboard position.

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

setPosition3v(position)

og/entity/BaseBillboard.js, line 148

Sets billboard position.

Name	Type	Description
position	Vec3	Cartesian coordinates.

setRotation(rotation)

og/entity/BaseBillboard.js, line 210

Sets billboard screen space rotation in radians.

Name	Type	Description
rotation	number	Screen space rotation in radians.

setVisibility(visibility)

og/entity/BaseBillboard.js, line 300

Sets billboard visibility.

Name	Type	Description
visibility	boolean	Visibility flag.