openglobus

Class: Billboard

og/entity/Billboard~Billboard

Represents basic quad billboard image.

new Billboard(options)

og/entity/Billboard.js, line 26
Name Type Description
options Object optional Options:
Name Type Description
position Vec3 | Array.<number> optional Billboard spatial position.
rotation number optional Screen angle rotaion.
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.

Extends

  • BaseBillboard

Members

protected_heightnumber

Billboard screen height.

protected_imageObject

Image object.

protected_srcstring

Image src.

protected_widthnumber

Billboard screen width.

Methods

getHeight(){number}

og/entity/Billboard.js, line 160
Gets billboard screen height.
Returns:
Type Description
number

getSize(){Object}

og/entity/Billboard.js, line 121
Returns billboard screen size.
Returns:
Type Description
Object

getWidth(){number}

og/entity/Billboard.js, line 142
Gets billboard screen width.
Returns:
Type Description
number

setHeight(height)

og/entity/Billboard.js, line 151
Sets billboard screen heigh.
Name Type Description
height number Height.

setImage(image)

og/entity/Billboard.js, line 99
Sets image object.
Name Type Description
image Object JavaScript image object.

setSize(width, height)

og/entity/Billboard.js, line 109
Sets billboard screen size in pixels.
Name Type Description
width number Billboard width.
height number Billboard height.

setSrc(src)

og/entity/Billboard.js, line 68
Sets billboard image url source.
Name Type Description
src string Image url.

setWidth(width)

og/entity/Billboard.js, line 133
Sets billboard screen width.
Name Type Description
width number Width.