API Docs for: 0.7.1
Show:

Ray Class

Defined in: src/collision/Ray.js:8

A line with a start and end point that is used to intersect shapes. For an example, see World.raycast

Constructor

Ray

(
  • [options]
)

Defined in src/collision/Ray.js:8

Parameters:

  • [options] Object optional
    • [from] Array optional
    • [to] Array optional
    • [checkCollisionResponse=true] Boolean optional
    • [skipBackfaces=false] Boolean optional
    • [collisionMask=-1] Number optional
    • [collisionGroup=-1] Number optional
    • [mode=Ray.ANY] Number optional
    • [callback] Number optional

Methods

getAABB

(
  • aabb
)

Defined in src/collision/Ray.js:211

Get the AABB of the ray.

Parameters:

intersectBodies

(
  • bodies
)

Defined in src/collision/Ray.js:125

Parameters:

  • bodies Array

    An array of Body objects.

intersectBody

(
  • body
)
private

Defined in src/collision/Ray.js:141

Shoot a ray at a body, get back information about the hit.

Parameters:

intersectShape

(
  • shape
  • angle
  • position
  • body
)
private

Defined in src/collision/Ray.js:186

Parameters:

  • shape Shape
  • angle Number
  • position Array
  • body Body

reportIntersection

(
  • fraction
  • normal
  • [faceIndex=-1]
)
Boolean private

Defined in src/collision/Ray.js:233

Parameters:

  • fraction Number
  • normal Array
  • [faceIndex=-1] Number optional

Returns:

Boolean:

True if the intersections should continue

update

()

Defined in src/collision/Ray.js:111

Should be called if you change the from or to point.

Properties

ALL

Number static

Defined in src/collision/Ray.js:104

This raycasting mode will traverse all intersection points and executes a callback for each one.

ANY

Number static

Defined in src/collision/Ray.js:97

This raycasting mode will make the Ray stop when it finds the first intersection point.

callback

Function

Defined in src/collision/Ray.js:67

Current, user-provided result callback. Will be used if mode is Ray.ALL.

checkCollisionResponse

Boolean

Defined in src/collision/Ray.js:37

Set to true if you want the Ray to take .collisionResponse flags into account on bodies and shapes.

CLOSEST

Number static

Defined in src/collision/Ray.js:90

This raycasting mode will make the Ray traverse through all intersection points and only return the closest one.

collisionGroup

Number

Defined in src/collision/Ray.js:55

Default: -1

collisionMask

Number

Defined in src/collision/Ray.js:49

Default: -1

direction

Array

Defined in src/collision/Ray.js:73

from

Array

Defined in src/collision/Ray.js:25

Ray start point.

length

Number

Defined in src/collision/Ray.js:79

Length of the ray

mode

Number

Defined in src/collision/Ray.js:61

The intersection mode. Should be Ray.ANY, Ray.ALL or Ray.CLOSEST.

skipBackfaces

Boolean

Defined in src/collision/Ray.js:43

If set to true, the ray skips any hits with normal.dot(rayDirection) < 0.

to

Array

Defined in src/collision/Ray.js:31

Ray end point