Class Ray

constructor

• new Ray(origin?: Vector3, direction?: Vector3): Ray

  Parameters

  • Optionalorigin: Vector3
  • Optionaldirection: Vector3

  Returns Ray

direction

new THREE.Vector3( 0, 0, - 1 )
Copy

origin

new THREE.Vector3()
Copy

applyMatrix4

• applyMatrix4(matrix4: Matrix4): Ray

  Parameters

  • matrix4: Matrix4

  Returns Ray

at

• at(t: number, target: Vector3): Vector3

  Parameters

  • t: number
  • target: Vector3

  Returns Vector3

clone

• clone(): this

  Returns this

closestPointToPoint

• closestPointToPoint(point: Vector3, target: Vector3): Vector3

  Parameters

  • point: Vector3
  • target: Vector3

  Returns Vector3

copy

• copy(ray: Ray): this

  Parameters

  • ray: Ray

  Returns this

distanceSqToPoint

• distanceSqToPoint(point: Vector3): number

  Parameters

  • point: Vector3

  Returns number

distanceSqToSegment

• distanceSqToSegment(
      v0: Vector3,
      v1: Vector3,
      optionalPointOnRay?: Vector3,
      optionalPointOnSegment?: Vector3,
  ): number

  Parameters

  • v0: Vector3
  • v1: Vector3
  • OptionaloptionalPointOnRay: Vector3
  • OptionaloptionalPointOnSegment: Vector3

  Returns number

distanceToPlane

• distanceToPlane(plane: Plane): number

  Parameters

  • plane: Plane

  Returns number

distanceToPoint

• distanceToPoint(point: Vector3): number

  Parameters

  • point: Vector3

  Returns number

equals

• equals(ray: Ray): boolean

  Parameters

  • ray: Ray

  Returns boolean

intersectBox

• intersectBox(box: Box3, target: Vector3): Vector3 | null

  Parameters

  • box: Box3
  • target: Vector3

  Returns Vector3 | null

intersectPlane

• intersectPlane(plane: Plane, target: Vector3): Vector3 | null

  Parameters

  • plane: Plane
  • target: Vector3

  Returns Vector3 | null

intersectsBox

• intersectsBox(box: Box3): boolean

  Parameters

  • box: Box3

  Returns boolean

intersectSphere

• intersectSphere(sphere: Sphere, target: Vector3): Vector3 | null

  Parameters

  • sphere: Sphere
  • target: Vector3

  Returns Vector3 | null

intersectsPlane

• intersectsPlane(plane: Plane): boolean

  Parameters

  • plane: Plane

  Returns boolean

intersectsSphere

• intersectsSphere(sphere: Sphere): boolean

  Parameters

  • sphere: Sphere

  Returns boolean

intersectTriangle

• intersectTriangle(
      a: Vector3,
      b: Vector3,
      c: Vector3,
      backfaceCulling: boolean,
      target: Vector3,
  ): Vector3 | null

  Parameters

  • a: Vector3
  • b: Vector3
  • c: Vector3
  • backfaceCulling: boolean
  • target: Vector3

  Returns Vector3 | null

isIntersectionBox

• isIntersectionBox(b: any): any

  Parameters

  • b: any

  Returns any

  Deprecated

  Use .intersectsBox() instead.

isIntersectionPlane

• isIntersectionPlane(p: any): any

  Parameters

  • p: any

  Returns any

  Deprecated

  Use .intersectsPlane() instead.

isIntersectionSphere

• isIntersectionSphere(s: any): any

  Parameters

  • s: any

  Returns any

  Deprecated

  Use .intersectsSphere() instead.

lookAt

• lookAt(v: Vector3): Ray

  Parameters

  • v: Vector3

  Returns Ray

recast

• recast(t: number): Ray

  Parameters

  • t: number

  Returns Ray

set

• set(origin: Vector3, direction: Vector3): Ray

  Parameters

  • origin: Vector3
  • direction: Vector3

  Returns Ray