Class: Billboard

og/entity/Billboard~Billboard

Represents basic quad billboard image.

new Billboard(options)

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.
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

  • og.BaseBillboard

Members

protected_heightnumber

Billboard screen height.

protected_imageObject

Image object.

protected_srcstring

Image src.

protected_widthnumber

Billboard screen width.

Methods

getHeight(){number}

Gets billboard screen height.
Returns:
Type Description
number
Returns billboard screen size.
Returns:
Type Description
Object

getWidth(){number}

Gets billboard screen width.
Returns:
Type Description
number

setHeight(height)

Sets billboard screen heigh.
Name Type Description
height number Height.

setImage(image)

Sets image object.
Name Type Description
image Object JavaScript image object.

setSize(width, height)

Sets billboard screen size in pixels.
Name Type Description
width number Billboard width.
height number Billboard height.
Sets billboard image url source.
Name Type Description
src string Image url.

setWidth(width)

Sets billboard screen width.
Name Type Description
width number Width.