Class: Ray

Constructor

new Ray(optionsopt)

Parameters:

Name Type Attributes Description

options

Object

Options:

Properties

Name	Type	Attributes	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.

Source: entity/Ray.ts, line 17

Members

Methods

getEndPosition() → {Vec3}

Returns ray end position.

Source: entity/Ray.ts, line 244

Returns:

Type:: Vec3

getPoint(distance) → {Vec3}

Computes the point along the ray on the distance.

Parameters:

Name	Type	Description
`distance`	number	Point distance.

Source: math/Ray.ts, line 67

Returns:

Type:: Vec3

getStartPosition() → {Vec3}

Returns ray start position.

Source: entity/Ray.ts, line 235

Returns:

Type:: Vec3

getVisibility() → {boolean}

Returns visibility.

Source: entity/Ray.ts, line 263

Returns:

Type:: boolean

hitPlane(v0, v1, v2, res) → {number}

Gets a ray hit a plane result. If the ray cross the plane returns 1 - og.Ray.INSIDE otherwise returns 0 - og.Ray.OUTSIDE.

Parameters:

Name	Type	Description
`v0`	Vec3	First plane point.
`v1`	Vec3	Second plane point.
`v2`	Vec3	Third plane point.
`res`	Vec3	Hit point object pointer that stores hit result.

Source: math/Ray.ts, line 140

Returns:

Type:: number

hitSphere(sphere) → {Vec3}

Returns a ray hit sphere coordiante. If there isn't hit returns null.

Parameters:

Name	Type	Description
`sphere`	Sphere	Sphere object.

Source: math/Ray.ts, line 181

Returns:

Type:: Vec3

hitTriangle(v0, v1, v2, res) → {number}

Returns ray hit a triange result.

Parameters:

Name	Type	Description
`v0`	Vec3	First triangle corner coordinate.
`v1`	Vec3	Second triangle corner coordinate.
`v2`	Vec3	Third triangle corner coordinate.
`res`	Vec3	Hit point object pointer that stores hit result.

Source: math/Ray.ts, line 77

Returns:

Hit code, could 0 - og.Ray.OUTSIDE, 1 - og.Ray.INSIDE, 2 - og.Ray.INPLANE and 3 - og.Ray.AWAY(ray goes away from triangle).

Type:: number

remove()

Remove from handler.

Source: entity/Ray.ts, line 272

set(origin, direction) → {Ray}

Sets a ray parameters.

Parameters:

Name	Type	Description
`origin`	Vec3	The origin of the ray.
`direction`	Vec3	The direction of the ray.

Source: math/Ray.ts, line 54

Returns:

Type:: Ray

setEndPosition(x, y, z)

Sets ray end position.

Parameters:

Name	Type	Description
`x`	number	X coordinate.
`y`	number	Y coordinate.
`z`	number	Z coordinate.

Source: entity/Ray.ts, line 161

setEndPosition3v(position)

Sets ray end position.

Parameters:

Name	Type	Description
`position`	Vec3	Cartesian coordinates.

Source: entity/Ray.ts, line 181

setPickingColor3v(color)

Set picking color.

Parameters:

Name	Type	Description
`color`	Vec3	Picking color.

Source: entity/Ray.ts, line 281

setStartPosition(x, y, z)

Sets ray start position.

Parameters:

Name	Type	Description
`x`	number	X coordinate.
`y`	number	Y coordinate.
`z`	number	Z coordinate.

Source: entity/Ray.ts, line 111

setStartPosition3v(position)

Sets ray start position.

Parameters:

Name	Type	Description
`position`	Vec3	Cartesian coordinates.

Source: entity/Ray.ts, line 139

setVisibility(visibility)

Sets visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Visibility flag.

Source: entity/Ray.ts, line 253

Constructor

new Ray(origin, direction)

Parameters:

Name	Type	Description
`origin`	Vec3	The origin of the ray.
`direction`	Vec3	The direction of the ray.

Source: math/Ray.ts, line 6

Members

(static, constant) AWAY

Source: math/Ray.ts, line 52

(static, constant) INPLANE

Source: math/Ray.ts, line 47

(static, constant) INSIDE

Source: math/Ray.ts, line 42

(static, constant) OUTSIDE

Source: math/Ray.ts, line 37

Methods

getEndPosition() → {Vec3}

Returns ray end position.

Source: entity/Ray.ts, line 244

Returns:

Type:: Vec3

getPoint(distance) → {Vec3}

Computes the point along the ray on the distance.

Parameters:

Name	Type	Description
`distance`	number	Point distance.

Source: math/Ray.ts, line 67

Returns:

Type:: Vec3

getStartPosition() → {Vec3}

Returns ray start position.

Source: entity/Ray.ts, line 235

Returns:

Type:: Vec3

getVisibility() → {boolean}

Returns visibility.

Source: entity/Ray.ts, line 263

Returns:

Type:: boolean

hitPlane(v0, v1, v2, res) → {number}

Gets a ray hit a plane result. If the ray cross the plane returns 1 - og.Ray.INSIDE otherwise returns 0 - og.Ray.OUTSIDE.

Parameters:

Name	Type	Description
`v0`	Vec3	First plane point.
`v1`	Vec3	Second plane point.
`v2`	Vec3	Third plane point.
`res`	Vec3	Hit point object pointer that stores hit result.

Source: math/Ray.ts, line 140

Returns:

Type:: number

hitSphere(sphere) → {Vec3}

Returns a ray hit sphere coordiante. If there isn't hit returns null.

Parameters:

Name	Type	Description
`sphere`	Sphere	Sphere object.

Source: math/Ray.ts, line 181

Returns:

Type:: Vec3

hitTriangle(v0, v1, v2, res) → {number}

Returns ray hit a triange result.

Parameters:

Name	Type	Description
`v0`	Vec3	First triangle corner coordinate.
`v1`	Vec3	Second triangle corner coordinate.
`v2`	Vec3	Third triangle corner coordinate.
`res`	Vec3	Hit point object pointer that stores hit result.

Source: math/Ray.ts, line 77

Returns:

Hit code, could 0 - og.Ray.OUTSIDE, 1 - og.Ray.INSIDE, 2 - og.Ray.INPLANE and 3 - og.Ray.AWAY(ray goes away from triangle).

Type:: number

remove()

Remove from handler.

Source: entity/Ray.ts, line 272

set(origin, direction) → {Ray}

Sets a ray parameters.

Parameters:

Name	Type	Description
`origin`	Vec3	The origin of the ray.
`direction`	Vec3	The direction of the ray.

Source: math/Ray.ts, line 54

Returns:

Type:: Ray

setEndPosition(x, y, z)

Sets ray end position.

Parameters:

Name	Type	Description
`x`	number	X coordinate.
`y`	number	Y coordinate.
`z`	number	Z coordinate.

Source: entity/Ray.ts, line 161

setEndPosition3v(position)

Sets ray end position.

Parameters:

Name	Type	Description
`position`	Vec3	Cartesian coordinates.

Source: entity/Ray.ts, line 181

setPickingColor3v(color)

Set picking color.

Parameters:

Name	Type	Description
`color`	Vec3	Picking color.

Source: entity/Ray.ts, line 281

setStartPosition(x, y, z)

Sets ray start position.

Parameters:

Name	Type	Description
`x`	number	X coordinate.
`y`	number	Y coordinate.
`z`	number	Z coordinate.

Source: entity/Ray.ts, line 111

setStartPosition3v(position)

Sets ray start position.

Parameters:

Name	Type	Description
`position`	Vec3	Cartesian coordinates.

Source: entity/Ray.ts, line 139

setVisibility(visibility)

Sets visibility.

Parameters:

Name	Type	Description
`visibility`	boolean	Visibility flag.

Source: entity/Ray.ts, line 253