Class Vec3

3D vector used for constraint impulses and other 3-component values.

Supports object pooling via Vec3.get() / dispose().

Converted from nape-compiled.js lines 24120–25040.

Index

Constructors

Accessors

Methods

clone dispose equals lsq set setxyz toString xy get

Constructors

constructor

new Vec3(x?: number, y?: number, z?: number): Vec3
Create a Vec3 with the given components. Defaults to (0, 0, 0).
Parameters
- x: number = 0
  The x component.
- y: number = 0
  The y component.
- z: number = 0
  The z component.
Returns Vec3
- Defined in packages/nape-js/src/geom/Vec3.ts:41

Accessors

length

get length(): number
Magnitude of the 3D vector.

Returns number
The Euclidean length sqrt(x² + y² + z²).
- Defined in packages/nape-js/src/geom/Vec3.ts:173
set length(value: number): void
Scale the vector to the given magnitude.
Parameters
- value: number
Returns void
Throws
If the vector has zero length.
- Defined in packages/nape-js/src/geom/Vec3.ts:184

x

get x(): number
The x component.

Returns number
- Defined in packages/nape-js/src/geom/Vec3.ts:128
set x(value: number): void
The x component.
Parameters
- value: number
Returns void
- Defined in packages/nape-js/src/geom/Vec3.ts:135

y

get y(): number
The y component.

Returns number
- Defined in packages/nape-js/src/geom/Vec3.ts:142
set y(value: number): void
The y component.
Parameters
- value: number
Returns void
- Defined in packages/nape-js/src/geom/Vec3.ts:149

z

get z(): number
The z component.

Returns number
- Defined in packages/nape-js/src/geom/Vec3.ts:156
set z(value: number): void
The z component.
Parameters
- value: number
Returns void
- Defined in packages/nape-js/src/geom/Vec3.ts:163

Methods

clone

clone(): Vec3
Return a new Vec3 with the same components.

Returns Vec3
A copy of this vector.
- Defined in packages/nape-js/src/geom/Vec3.ts:283

dispose

dispose(): void
Return this Vec3 to the object pool.

Returns void
Throws
If this Vec3 has already been disposed.
- Defined in packages/nape-js/src/geom/Vec3.ts:304

equals

equals(other: Vec3, epsilon?: number): boolean
Check whether this Vec3 is component-wise equal to another, within an optional epsilon tolerance.
Parameters
- other: Vec3
  The Vec3 to compare against.
- epsilon: number = 0
  Maximum allowed difference per component (default 0).
Returns boolean
true if all three components differ by at most epsilon.
- Defined in packages/nape-js/src/geom/Vec3.ts:259

lsq

lsq(): number
Squared magnitude. Faster than length as it avoids a square root.

Returns number
x² + y² + z².
- Defined in packages/nape-js/src/geom/Vec3.ts:210

set

set(vector: Vec3): this
Copy another Vec3's components into this one in-place.
Parameters
- vector: Vec3
  The source Vec3 to copy from.
Returns this
this for chaining.
- Defined in packages/nape-js/src/geom/Vec3.ts:222

setxyz

setxyz(x: number, y: number, z: number): this
Set all three components at once in-place.
Parameters
- x: number
  The new x component.
- y: number
  The new y component.
- z: number
  The new z component.
Returns this
this for chaining.
- Defined in packages/nape-js/src/geom/Vec3.ts:241

toString

toString(): string
String representation { x: … y: … z: … }.

Returns string
A human-readable string of the three components.
- Defined in packages/nape-js/src/geom/Vec3.ts:325

xy

xy(weak?: boolean): Vec2
Return the x and y components as a new Vec2.
Parameters
- weak: boolean = false
  If true, the returned Vec2 is a weak (pooled) reference.
Returns Vec2
A new Vec2 containing this vector's x and y components.
- Defined in packages/nape-js/src/geom/Vec3.ts:294

`Static`get

get(x?: number, y?: number, z?: number): Vec3
Allocate a Vec3 from the public object pool, or create a new one if the pool is empty.
Parameters
- x: number = 0
  Initial x component (default 0).
- y: number = 0
  Initial y component (default 0).
- z: number = 0
  Initial z component (default 0).
Returns Vec3
A Vec3 initialised with the given components.
- Defined in packages/nape-js/src/geom/Vec3.ts:104