Class: Ray

og/entity/BaseBillboard~Ray

Ray class.

new Ray(options)

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

Members

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_visibilityboolean

Ray visibility.

readonlyidnumber

Object unic identifier.

Methods

getEndPosition(){og.Vec3}

Returns ray end position.
Returns:
Type Description
og.Vec3

getStartPosition(){og.Vec3}

Returns ray start position.
Returns:
Type Description
og.Vec3

getVisibility(){boolean}

Returns billboard visibility.
Returns:
Type Description
boolean
Removes billboard from hander.

setEndPosition(x, y, z)

Sets ray end position.
Name Type Description
x number X coordinate.
y number Y coordinate.
z number Z coordinate.

setEndPosition3v(position)

Sets ray end position.
Name Type Description
position og.Vec3 Cartesian coordinates.

setPickingColor3v(color)

Sets billboard picking color.
Name Type Description
color og.Vec3 Picking color.

setStartPosition(x, y, z)

Sets ray start position.
Name Type Description
x number X coordinate.
y number Y coordinate.
z number Z coordinate.

setStartPosition3v(position)

Sets ray start position.
Name Type Description
position og.Vec3 Cartesian coordinates.

setVisibility(visibility)

Sets billboard visibility.
Name Type Description
visibility boolean Visibility flag.