openglobus

Class: Ray

og/entity/BaseBillboard~Ray

Ray class.

new Ray(options)

og/entity/Ray.js, line 22
Name Type Description
options Object optional Options:
Name Type Description
startPosition Vec3 | Array.<number> optional Ray start point position.
endPosition Vec3 | Array.<number> optional Ray end point position.
startColor Vec3 | Array.<number> optional Ray start point color.
endColor Vec3 | Array.<number> optional Ray end point color.
visibility boolean optional Visibility.

Members

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_visibilityboolean

Ray visibility.

readonlyidnumber

Object unic identifier.

Methods

getEndPosition(){Vec3}

og/entity/Ray.js, line 231
Returns ray end position.
Returns:
Type Description
Vec3

getStartPosition(){Vec3}

og/entity/Ray.js, line 222
Returns ray start position.
Returns:
Type Description
Vec3

getVisibility(){boolean}

og/entity/Ray.js, line 250
Returns billboard visibility.
Returns:
Type Description
boolean

remove()

og/entity/Ray.js, line 258
Removes billboard from hander.

setEndPosition(x, y, z)

og/entity/Ray.js, line 144
Sets ray end position.
Name Type Description
x number X coordinate.
y number Y coordinate.
z number Z coordinate.

setEndPosition3v(position)

og/entity/Ray.js, line 162
Sets ray end position.
Name Type Description
position Vec3 Cartesian coordinates.

setPickingColor3v(color)

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

setStartPosition(x, y, z)

og/entity/Ray.js, line 98
Sets ray start position.
Name Type Description
x number X coordinate.
y number Y coordinate.
z number Z coordinate.

setStartPosition3v(position)

og/entity/Ray.js, line 120
Sets ray start position.
Name Type Description
position Vec3 Cartesian coordinates.

setVisibility(visibility)

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