Class Ray

A line in 3D space that intersects bodies and return points.

Index

Constructors

constructor

new Ray(from?, to?): Ray
Parameters
- Optional from: Vec3
- Optional to: Vec3
Returns Ray

Properties

callback

callback: RaycastCallback

User-provided result callback. Will be used if mode is Ray.ALL.

checkCollisionResponse

checkCollisionResponse: boolean

Set to false if you don't want the Ray to take collisionResponse flags into account on bodies and shapes.

Default

true

collisionFilterGroup

collisionFilterGroup: number

collisionFilterGroup

Default

-1

collisionFilterMask

collisionFilterMask: number

collisionFilterMask

Default

-1

direction

direction: Vec3

direction

from

from: Vec3

from

hasHit

hasHit: boolean

Will be set to true during intersectWorld() if the ray hit anything.

mode

mode: number

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

Default

RAY.ANY

precision

precision: number

The precision of the ray. Used when checking parallelity etc.

Default

0.0001

result

result: RaycastResult

Current result object.

skipBackfaces

skipBackfaces: boolean

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

Default

false

to

to: Vec3

`Static` ALL

ALL: 4

ALL

`Static` ANY

ANY: 2

ANY

`Static` CLOSEST

CLOSEST: 1

CLOSEST

Accessors

1

get 1(): ((sphere, quat, position, body, reportedShape) => void)
Returns ((sphere, quat, position, body, reportedShape) => void)
- - (sphere, quat, position, body, reportedShape): void
  - Parameters
    - sphere: Sphere
    - quat: Quaternion
    - position: Vec3
    - body: Body
    - reportedShape: Shape
    Returns void

128

get 128(): ((shape, quat, position, body, reportedShape, options?) => void)
Returns ((shape, quat, position, body, reportedShape, options?) => void)
- - (shape, quat, position, body, reportedShape, options?): void
  - Parameters
    - shape: ConvexPolyhedron
    - quat: Quaternion
    - position: Vec3
    - body: Body
    - reportedShape: Shape
    - Optional options: {
      faceList: number[];
      }
      faceList: number[]
    Returns void

16

get 16(): ((shape, quat, position, body, reportedShape, options?) => void)
Returns ((shape, quat, position, body, reportedShape, options?) => void)
- - (shape, quat, position, body, reportedShape, options?): void
  - Parameters
    - shape: ConvexPolyhedron
    - quat: Quaternion
    - position: Vec3
    - body: Body
    - reportedShape: Shape
    - Optional options: {
      faceList: number[];
      }
      faceList: number[]
    Returns void

2

get 2(): ((shape, quat, position, body, reportedShape) => void)
Returns ((shape, quat, position, body, reportedShape) => void)
- - (shape, quat, position, body, reportedShape): void
  - Parameters
    - shape: Plane
    - quat: Quaternion
    - position: Vec3
    - body: Body
    - reportedShape: Shape
    Returns void

256

get 256(): ((mesh, quat, position, body, reportedShape, options?) => void)
Returns ((mesh, quat, position, body, reportedShape, options?) => void)
- - (mesh, quat, position, body, reportedShape, options?): void
  - Parameters
    - mesh: Trimesh
    - quat: Quaternion
    - position: Vec3
    - body: Body
    - reportedShape: Shape
    - Optional options: {
      faceList?: any[];
      }
      Optional faceList?: any[]
    Returns void

32

get 32(): ((shape, quat, position, body, reportedShape) => void)
Returns ((shape, quat, position, body, reportedShape) => void)
- - (shape, quat, position, body, reportedShape): void
  - Parameters
    - shape: Heightfield
    - quat: Quaternion
    - position: Vec3
    - body: Body
    - reportedShape: Shape
    Returns void

4

get 4(): ((box, quat, position, body, reportedShape) => void)
Returns ((box, quat, position, body, reportedShape) => void)
- - (box, quat, position, body, reportedShape): void
  - Parameters
    - box: Box
    - quat: Quaternion
    - position: Vec3
    - body: Body
    - reportedShape: Shape
    Returns void

Methods

_intersectBox

_intersectBox(box, quat, position, body, reportedShape): void
Parameters
- box: Box
- quat: Quaternion
- position: Vec3
- body: Body
- reportedShape: Shape
Returns void

_intersectConvex

_intersectConvex(shape, quat, position, body, reportedShape, options?): void
Parameters
- shape: ConvexPolyhedron
- quat: Quaternion
- position: Vec3
- body: Body
- reportedShape: Shape
- Optional options: {
  faceList: number[];
  }
  - faceList: number[]
Returns void

_intersectHeightfield

_intersectHeightfield(shape, quat, position, body, reportedShape): void
Parameters
- shape: Heightfield
- quat: Quaternion
- position: Vec3
- body: Body
- reportedShape: Shape
Returns void

_intersectPlane

_intersectPlane(shape, quat, position, body, reportedShape): void
Parameters
- shape: Plane
- quat: Quaternion
- position: Vec3
- body: Body
- reportedShape: Shape
Returns void

_intersectSphere

_intersectSphere(sphere, quat, position, body, reportedShape): void
Parameters
- sphere: Sphere
- quat: Quaternion
- position: Vec3
- body: Body
- reportedShape: Shape
Returns void

_intersectTrimesh

_intersectTrimesh(mesh, quat, position, body, reportedShape, options?): void
Parameters
- mesh: Trimesh
- quat: Quaternion
- position: Vec3
- body: Body
- reportedShape: Shape
- Optional options: {
  faceList?: any[];
  }
  - Optional faceList?: any[]
Returns void
Todo
Optimize by transforming the world to local space first.

Todo
Use Octree lookup

getAABB

getAABB(aabb): void
Get the world AABB of the ray.
Parameters
- aabb: AABB
Returns void

intersectBodies

intersectBodies(bodies, result?): void
Shoot a ray at an array bodies, get back information about the hit.
Parameters
- bodies: Body[]
  An array of Body objects.
- Optional result: RaycastResult
  set the result property of the Ray instead.
Returns void
Deprecated

intersectBody

intersectBody(body, result?): void
Shoot a ray at a body, get back information about the hit.
Parameters
- body: Body
- Optional result: RaycastResult
  set the result property of the Ray instead.
Returns void
Deprecated

intersectWorld

intersectWorld(world, options): boolean
Do itersection against all bodies in the given World.
Parameters
- world: World
- options: RayOptions
Returns boolean
True if the ray hit anything, otherwise false.

`Static` pointInTriangle

pointInTriangle(p, a, b, c): boolean
As per "Barycentric Technique" as named here but without the division
Parameters
- p: Vec3
- a: Vec3
- b: Vec3
- c: Vec3
Returns boolean

Class Ray

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional from: Vec3

Optional to: Vec3

Returns Ray

Properties

callback

checkCollisionResponse

Default

collisionFilterGroup

Default

collisionFilterMask

Default

direction

from

hasHit

mode

Default

precision

Default

result

skipBackfaces

Default

to

Static ALL

Static ANY

Static CLOSEST

Accessors

1

Returns ((sphere, quat, position, body, reportedShape) => void)

Parameters

sphere: Sphere

quat: Quaternion

position: Vec3

body: Body

reportedShape: Shape

Returns void

128

Returns ((shape, quat, position, body, reportedShape, options?) => void)

Parameters

shape: ConvexPolyhedron

quat: Quaternion

position: Vec3

body: Body

reportedShape: Shape

Optional options: { faceList: number[]; }

faceList: number[]

Returns void

16

Returns ((shape, quat, position, body, reportedShape, options?) => void)

Parameters

shape: ConvexPolyhedron

quat: Quaternion

position: Vec3

body: Body

reportedShape: Shape

Optional options: { faceList: number[]; }

faceList: number[]

Returns void

2

Returns ((shape, quat, position, body, reportedShape) => void)

Parameters

shape: Plane

quat: Quaternion

position: Vec3

body: Body

reportedShape: Shape

Returns void

256

Returns ((mesh, quat, position, body, reportedShape, options?) => void)

Parameters

mesh: Trimesh

quat: Quaternion

`Optional` from: Vec3

`Optional` to: Vec3

`Static` ALL

`Static` ANY

`Static` CLOSEST

`Optional` options: {
faceList: number[];
}

`Optional` options: {
faceList: number[];
}

`Optional` options: {
faceList?: any[];
}

`Optional` faceList?: any[]

`Optional` options: {
faceList: number[];
}