openglobus

Class: BaseBillboard

og/entity/BaseBillboard~BaseBillboard

Base prototype for billboard and label classes.

new BaseBillboard(options)

og/entity/BaseBillboard.js, line 20
Name Type Description
options Object optional Options:
Name Type Description
position og.Vec3 | Array.<number> optional Billboard spatial position.
rotation number optional Screen angle rotaion.
color og.Vec4 | string | Array.<number> optional Billboard color.
alignedAxis og.Vec3 | Array.<number> optional Billboard aligned vector.
offset og.Vec3 | Array.<number> optional Billboard center screen offset.
visibility boolean optional Visibility.

Members

protected_alignedAxisog.Vec3

Cartesian aligned axis vector.

protected_colorog.Vec4

RGBA color.

protected_entityog.Entity

Entity instance that holds this billboard.

protected_handlerog.BillboardHandler

Handler that stores and renders this billboard object.

protected_handlerIndexnumber

Billboard handler array index.

protected_offsetog.math.Vecto3

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

protected_positionog.Vec3

Billboard center cartesian position.

protected_rotationnumber

Screen space rotation angle.

protected_scalenumber

Billboard scale.

protected_visibilityboolean

Billboard visibility.

readonlyidnumber

Object unic identifier.

Methods

getAlignedAxis(){og.Vec3}

og/entity/BaseBillboard.js, line 329
Returns aligned vector.
Returns:
Type Description
og.Vec3

getColor(){og.Vec4}

og/entity/BaseBillboard.js, line 275
Returns RGBA color.
Returns:
Type Description
og.Vec4

getOffset(){og.Vec3}

og/entity/BaseBillboard.js, line 199
Returns billboard screen space offset size.
Returns:
Type Description
og.Vec3

getPosition(){og.Vec3}

og/entity/BaseBillboard.js, line 145
Returns billboard position.
Returns:
Type Description
og.Vec3

getRotation(){number}

og/entity/BaseBillboard.js, line 218
Gets screen space rotation.
Returns:
Type Description
number

getScale(){number}

og/entity/BaseBillboard.js, line 178
Gets billboard scale.
Returns:
Type Description
number

getVisibility(){boolean}

og/entity/BaseBillboard.js, line 294
Returns billboard visibility.
Returns:
Type Description
boolean

remove()

og/entity/BaseBillboard.js, line 337
Removes billboard from hander.

setAlignedAxis(x, y, z)

og/entity/BaseBillboard.js, line 305
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 317
Sets billboard aligned vector.
Name Type Description
alignedAxis og.math.Vecto3 Vector to align.

setColor(r, g, b, a)

og/entity/BaseBillboard.js, line 240
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 253
Sets RGBA color. Each channel from 0.0 to 1.0.
Name Type Description
color og.Vec4 RGBA vector.

setColorHTML(color)

og/entity/BaseBillboard.js, line 266
Sets billboard color.
Name Type Description
color string HTML style color.

setOffset(x, y, z)

og/entity/BaseBillboard.js, line 156
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 187
Sets screen space offset.
Name Type Description
offset og.Vec2 Offset size.

setOpacity(a)

og/entity/BaseBillboard.js, line 227
Sets billboard opacity.
Name Type Description
a number Billboard opacity.

setPickingColor3v(color)

og/entity/BaseBillboard.js, line 347
Sets billboard picking color.
Name Type Description
color og.Vec3 Picking color.

setPosition(x, y, z)

og/entity/BaseBillboard.js, line 121
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 133
Sets billboard position.
Name Type Description
position og.Vec3 Cartesian coordinates.

setRotation(rotation)

og/entity/BaseBillboard.js, line 208
Sets billboard screen space rotation in radians.
Name Type Description
rotation number Screen space rotation in radians.

setScale(scale)

og/entity/BaseBillboard.js, line 168
Sets billboard scale.
Name Type Description
scale number Scale.

setVisibility(visibility)

og/entity/BaseBillboard.js, line 284
Sets billboard visibility.
Name Type Description
visibility boolean Visibility flag.