Class Ray

A ray for raycasting queries.

Fully modernized — uses ZPP_Ray directly (extracted to TypeScript).

Index

Constructors

Accessors

direction maxDistance origin userData

Methods

aabb at clone copy fromSegment

Constructors

constructor

new Ray(origin: Vec2, direction: Vec2): Ray
Create a Ray from an origin point and a direction vector. Both must be non-null, non-disposed Vec2s.
Parameters
- origin: Vec2
  The start point of the ray in world coordinates.
- direction: Vec2
  The direction vector (need not be unit length).
Returns Ray
- Defined in packages/nape-js/src/geom/Ray.ts:53

Accessors

direction

get direction(): Vec2
The ray's direction vector (need not be unit length; the engine normalises internally).

Returns Vec2
- Defined in packages/nape-js/src/geom/Ray.ts:180
set direction(value: Vec2): void
The ray's direction vector (need not be unit length; the engine normalises internally).
Parameters
- value: Vec2
Returns void
- Defined in packages/nape-js/src/geom/Ray.ts:185

maxDistance

get maxDistance(): number
Maximum travel distance for raycasting queries. Defaults to Infinity.

Returns number
- Defined in packages/nape-js/src/geom/Ray.ts:198
set maxDistance(value: number): void
Maximum travel distance for raycasting queries. Defaults to Infinity.
Parameters
- value: number
Returns void
- Defined in packages/nape-js/src/geom/Ray.ts:203

origin

get origin(): Vec2
The ray's start point in world coordinates.

Returns Vec2
- Defined in packages/nape-js/src/geom/Ray.ts:163
set origin(value: Vec2): void
The ray's start point in world coordinates.
Parameters
- value: Vec2
Returns void
- Defined in packages/nape-js/src/geom/Ray.ts:168

userData

get userData(): Record<string, unknown>
Arbitrary user data attached to this Ray.

Returns Record<string, unknown>
- Defined in packages/nape-js/src/geom/Ray.ts:211

Methods

aabb

aabb(): AABB
Compute the axis-aligned bounding box that encloses the ray from origin to maxDistance.

Returns AABB
A new AABB wrapping the ray's extent.
- Defined in packages/nape-js/src/geom/Ray.ts:226

at

at(distance: number, weak?: boolean): Vec2
Return the world-space point at distance along the ray.
Parameters
- distance: number
  Distance from the ray origin along the ray direction.
- weak: boolean = false
  If true, the returned Vec2 is a weak (pooled) reference.
Returns Vec2
The point origin + distance * normalised_direction.
- Defined in packages/nape-js/src/geom/Ray.ts:236

clone

clone(): Ray
Return a new Ray with the same origin, direction, and maxDistance. Alias for copy().

Returns Ray
A new Ray with the same properties.
- Defined in packages/nape-js/src/geom/Ray.ts:255

copy

copy(): Ray
Return a new Ray with the same origin, direction, and maxDistance.

Returns Ray
A deep copy of this Ray.
- Defined in packages/nape-js/src/geom/Ray.ts:263

`Static`fromSegment

fromSegment(start: Vec2, end: Vec2): Ray
Create a Ray from a line segment. The ray origin is start, direction is end − start, and maxDistance is the segment length.
Parameters
- start: Vec2
  The start point of the segment.
- end: Vec2
  The end point of the segment.
Returns Ray
A new Ray spanning the segment.
- Defined in packages/nape-js/src/geom/Ray.ts:120