Class: Vector

Class representing a vector in 3D space.

Vectors are the building blocks of 3D geometry. A Vector represents a point or direction in 3D space with x, y, and z coordinates. You'll use vectors everywhere - to define positions, directions, distances, and transformations.

When to use Vector

• Positioning objects - specify where geometry lives in 3D space
• Defining directions - set rotation axes, extrusion directions, normals
• Mathematical operations - add, subtract, cross product, dot product, normalize
• Measuring - calculate distances, angles between directions

Quick start

// Create vectors
const origin = new Vector(0, 0, 0);
const point = new Vector(10, 5, 3);

// Math operations
const direction = Vector.by2Point(origin, point);
const distance = origin.distance(point);
const normalized = direction.normalized();
const cross = direction.cross(new Vector(0, 0, 1));
const angle = direction.getAngle(new Vector(1, 0, 0));

// Transform
const moved = origin.translate(new Vector(5, 0, 0));
const rotated = point.rotated(Math.PI / 4);

// Get components
const x = point.x();
const y = point.y();
const tuple = point.toTuple(); // [10, 5, 3]

Key methods at a glance

Method: constructor

Constructs a new Vector object.

Parameters

• vector (Point): The vector to initialize the object with. Defaults to [0, 0, 0].

Example

const vector = /* specify a vector */;
const instance = new Vector();
instance.constructor(vector);

Method: vector

Gets the vector.

Returns

The vector.

Example

const instance = new Vector();
instance.vector();

Method: vector

Sets the vector for this object.

Parameters

• vector : The vector to set.

Example

const instance = new Vector();
instance.vector(vector);

Method: type

Gets the type of the vector.

Returns

The type of the vector.

Example

const instance = new Vector();
instance.type();

Method: x

Gets the x coordinate of the vector.

Returns

The x coordinate of the vector.

Example

const instance = new Vector();
instance.x();

Method: y

Gets the y coordinate of the vector.

Returns

The y coordinate of the vector.

Example

const instance = new Vector();
instance.y();

Method: z

Gets the z coordinate of the vector.

Returns

The z coordinate of the vector.

Example

const instance = new Vector();
instance.z();

Method: length

Returns the length of the vector.

Returns

The length of the vector.

Example

const instance = new Vector();
instance.length();

Method: toTuple

Converts the vector to a tuple representation.

Returns

The tuple representation of the vector as [x, y, z].

Example

const instance = new Vector();
instance.toTuple();

Static Method: by2Point

Creates a new Vector by subtracting the coordinates of the end Vector from the coordinates of the start Vector.

Parameters

• start (IVector): The start Vector.
• end (IVector): The end Vector.

Returns

A new Vector representing the difference between the end and start Vectors.

Example

const start = new Vector(0, 0, 0);
const end = new Vector(1, 1, 1);
Vector.by2Point(start, end);

Method: cross

Calculates the cross product of this vector and the given vector.

Parameters

• v (IVector): The vector to calculate the cross product with.

Returns

The resulting vector from the cross product operation.

Example

const v = new Vector(1, 1, 1);
const instance = new Vector();
instance.cross(v);

Method: dot

Calculates the dot product between this vector and the given vector.

Parameters

• v (IVector): The vector to calculate the dot product with.

Returns

The dot product of the two vectors.

Example

const v = new Vector(1, 1, 1);
const instance = new Vector();
instance.dot(v);

Method: sub

Subtracts the given vector from this vector.

Parameters

• v (IVector): The vector to subtract.

Returns

A new vector representing the subtraction result.

Example

const v = new Vector(1, 1, 1);
const instance = new Vector();
instance.sub(v);

Method: add

Adds a vector to the current vector.

Parameters

• v (IVector): The vector to be added.

Returns

A new vector that is the result of the addition.

Example

const v = new Vector(1, 1, 1);
const instance = new Vector();
instance.add(v);

Method: multiply

Multiplies the vector by the given scale.

Parameters

• scale (number): The scale factor to multiply the vector by.

Returns

A new Vector object representing the result of the multiplication.

Example

const scale = 0.5;
const instance = new Vector();
instance.multiply(scale);

Method: normalized

Returns a new Vector object that represents the normalized version of this vector.

Returns

A new Vector object representing the normalized vector.

Example

const instance = new Vector();
instance.normalized();

Method: normalize

Normalizes the vector.

Returns

The normalized vector.

Example

const instance = new Vector();
instance.normalize();

Method: getCenter

Returns the center vector.

Returns

The center vector.

Example

const instance = new Vector();
instance.getCenter();

Method: getAngle

Calculates the angle between two vectors.

Parameters

• v (IVector): The vector to calculate the angle with.

Returns

The angle between the two vectors in radians.

Example

const v = new Vector(1, 1, 1);
const instance = new Vector();
instance.getAngle(v);

Method: copy

Creates a copy of the vector.

Returns

A new instance of the Vector class with the same values as the original vector.

Example

const instance = new Vector();
instance.copy();

Method: projectToPlane

Projects the vector onto a plane.

Parameters

• plane (IPlane): The plane onto which the vector will be projected.

Returns

The projected vector.

Example

const plane = /* specify a plane */;
const instance = new Vector();
instance.projectToPlane(plane);

Method: equals

Checks if this vector is equal to the given vector.

Parameters

• other (IVector): The vector to compare with.

Returns

True if the vectors are equal, false otherwise.

Example

const other = new Vector(1, 1, 1);
const instance = new Vector();
instance.equals(other);

Method: toPnt

Converts the vector to a point in 3D space.

Returns

The converted point.

Example

const instance = new Vector();
instance.toPnt();

Method: toDir

Converts the vector to a direction.

Returns

The direction representation of the vector.

Example

const instance = new Vector();
instance.toDir();

Method: toVec

Converts the vector to a Vector object.

Returns

The converted Vector object.

Example

const instance = new Vector();
instance.toVec();

Method: reversed

Reverses the vector.

Returns

The reversed vector.

Example

const instance = new Vector();
instance.reversed();

Method: distance

Calculates the distance between two vectors.

Parameters

• second (IVector): The second vector to calculate the distance to.

Returns

The distance between the two vectors.

Example

const second = new Vector(1, 1, 1);
const instance = new Vector();
instance.distance(second);

Method: reverse

Reverses the vector in place.

Returns

The reversed vector.

Example

const instance = new Vector();
instance.reverse();

Method: rotated

Rotates the vector by the specified angle around the given center and direction.

Parameters

• angle (number): The angle (in radians) by which to rotate the vector.
• center (Point = [0): The center point around which to rotate the vector. Defaults to [0, 0, 0].

Returns

A new Vector object representing the rotated vector.

Example

const angle = 0.5;
const center = /* specify a center */;
const instance = new Vector();
instance.rotated(angle, center);

Method: translate

Translates the current vector by adding the given vector.

Parameters

• vector (IVector): The vector to be added.

Returns

A new vector representing the result of the translation.

Example

const vector = new Vector(1, 1, 1);
const instance = new Vector();
instance.translate(vector);

Method: rotate

Rotates the vector by the specified angle around the given center and direction.

Parameters

• angle (number): The angle (in radians) by which to rotate the vector.
• center (Point = [0): The center point around which to rotate the vector. Defaults to [0, 0, 0].

Returns

The rotated vector.

Example

const angle = 0.5;
const center = /* specify a center */;
const instance = new Vector();
instance.rotate(angle, center);

Method: setPlane

Sets the plane of the vector.

Parameters

• localPlane (IPlane): The local plane.

Returns

A new Vector object with the transformed vector.

Example

const localPlane = /* specify a localPlane */;
const instance = new Vector();
instance.setPlane(localPlane);

Method: mirrorByCurve

Mirrors the vector by a given curve.

Parameters

• curve (ICurve): The curve to mirror the vector by.

Returns

The mirrored vector.

Example

const curve = CurveBuilder.line(new Vector(0, 0, 0), new Vector(1, 1, 1));
const instance = new Vector();
instance.mirrorByCurve(curve);

Method: delete

Deletes the vector.

Example

const instance = new Vector();
instance.delete();

Method: dump

Returns a string representation of the vector.

Returns

The string representation of the vector.

Example

const instance = new Vector();
instance.dump();