encantar-js/docs/api/vector3.md

Vector3

A vector in 3D space.

Since: 0.4.0

Properties

x

vector.x: number

The x coordinate of the vector.

y

vector.y: number

The y coordinate of the vector.

z

vector.z: number

The z coordinate of the vector.

Methods

length

vector.length(): number

Compute the length of the vector: sqrt(x^2 + y^2 + z^2).

Returns

The length of the vector.

directionTo

vector.directionTo(v: Vector3): Vector3

Compute a unit vector pointing to v from this.

Arguments

• v: Vector3. A vector.

Returns

A new unit vector pointing to v from this.

equals

vector.equals(v: Vector3): boolean

Check if this and v have the same coordinates.

Arguments

• v: Vector3. A vector.

Returns

true if this and v have the same coordinates.

toString

vector.toString(): string

Generate a string representation of the vector.

Returns

A string representation of the vector.