Vector3 | CoSpaces API

Represents 3D points and vectors.

Use this class to pass positions and directions to item transforms and perform vector operations.

Note: By default, DX engine uses Z as "up".

Hierarchy

Vector3

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Vector3(x: number, y: number, z: number): Vector3

- Defined in api.ts:366
Parameters
- x: number
- y: number
- z: number
Returns Vector3

Properties

Readonly length

length: number

Returns the length of this vector.

The length is calculated by the square root of (x * x + y * y + z * z).

returns: length of this vector.

Readonly normalized

normalized: Vector3

Returns a copy of this vector with length 1.

Readonly sqrLength

sqrLength: number

Returns the squared length of this vector.

If you use vector lengths to compare distances, squared lengths are more performant and preferred to use.

returns: squared length of this vector

Readonly x

x: number

X component of this vector.

Readonly y

y: number

Y component of this vector.

Readonly z

z: number

Z component of this vector.

Static Readonly one

one: Vector3

Shorthand for writing new Vector3(1,1,1).

Static Readonly zero

zero: Vector3

Shorthand for writing new Vector3(0,0,0).

Methods

add

add(other: Vector3): Vector3

- Defined in api.ts:422
Adds this vector and other by their corresponding components.

Parameters
- other: Vector3
Returns Vector3
new vector of the combined result.

angle

angle(other: Vector3): number

- Defined in api.ts:467
Returns the angle in radians from this vector to other.

Parameters
- other: Vector3
Returns number
angle in radians.

cross

cross(other: Vector3): Vector3

- Defined in api.ts:377
Calculates the cross product of this vector and other

The cross product of two vectors results in a third vector which is perpendicular to the two input vectors. The result's magnitude is equal to the magnitudes of the two inputs multiplied together and then multiplied by the sine of the angle between the inputs. You can determine the direction of the result vector using the "left hand rule".

Parameters
- other: Vector3
Returns Vector3
cross product.

dist

dist(other: Vector3): number

- Defined in api.ts:504
Returns the distance between this vector and other.

Note: a.dist(other) is the same as a.sub(b).length.

Parameters
- other: Vector3
Returns number
distance between vectors.

div

div(d: number): Vector3

- Defined in api.ts:429
Divides all components of this vector by divisor d.

Parameters
- d: number
Returns Vector3
new vector of the divided result.

dot

dot(other: Vector3): number

- Defined in api.ts:477
Calculates the dot product of this vector and other.

The dot product is a number equal to the lengths of two vectors multiplied together and then multiplied by the cosine of the angle between them.

Parameters
- other: Vector3
Returns number
dot product.

equals

equals(v: Vector3): boolean

- Defined in api.ts:511
Returns true if this vector equals v.

Parameters
- v: Vector3
  
  vector to compare this vector against.
Returns boolean

limitLength

limitLength(l: number): Vector3

- Defined in api.ts:405
Returns a copy of this vector with limited length l.

Parameters
- l: number
Returns Vector3
limited length vector.

max

max(other: Vector3): Vector3

- Defined in api.ts:415
Returns a new vector made from the largest components of this vector and other

Parameters
- other: Vector3
Returns Vector3

min

min(other: Vector3): Vector3

- Defined in api.ts:410
Returns a new vector made from the smallest components of this vector and other

Parameters
- other: Vector3
Returns Vector3

mult

mult(m: number): Vector3

- Defined in api.ts:460
Multiplies each component of this by a number m.

Parameters
- m: number
  
  multiplier.
Returns Vector3
new vector of the multiplied result.

project

project(other: Vector3): Vector3

- Defined in api.ts:384
Projects this vector onto other.

Parameters
- other: Vector3
Returns Vector3
vector projection.

projectOnPlane

projectOnPlane(normal: Vector3): Vector3

- Defined in api.ts:393
Projects this vector onto a plane defined by a normal that is orthogonal to it.

Parameters
- normal: Vector3
  
  direction from the vector towards the plane.
Returns Vector3
location of vector on the plane

sub

sub(other: Vector3): Vector3

- Defined in api.ts:436
Subtracts each component of other from this vector.

Parameters
- other: Vector3
Returns Vector3
new vector of the subtracted result

toArray

toArray(): number[]

- Defined in api.ts:516
Returns number[]
array representation of this vector.

Static add

add(a: Vector3, b: Vector3): Vector3

- Defined in api.ts:532
Adds vector a and vector b by their corresponding components.

Parameters
- a: Vector3
- b: Vector3
Returns Vector3
new vector of combined result

Static angle

angle(a: Vector3, b: Vector3): number

- Defined in api.ts:546
Returns the angle in radians from this vector a to vector b.

Parameters
- a: Vector3
- b: Vector3
Returns number
angle in radians.

Static cross

cross(a: Vector3, b: Vector3): Vector3

- Defined in api.ts:567
Calculates the cross product of vector a and vector b.

The cross product of two vectors results in a third vector which is perpendicular to the two input vectors. The result's length is equal to the lengths of the two inputs multiplied together and then multiplied by the sine of the angle between the inputs. You can determine the direction of the result vector using the "left hand rule".

Parameters
- a: Vector3
- b: Vector3
Returns Vector3
cross product.

Static dist

dist(a: Vector3, b: Vector3): number

- Defined in api.ts:603
Returns the distance between vector a and vector b.

Note: a.dist(b) is the same as a.sub(b).length.

Parameters
- a: Vector3
- b: Vector3
Returns number
distance between vectors.

Static distance2

distance2(a: Vector3, b: Vector3): number

- Defined in api.ts:610
Returns the squared distance between vector a and vector b

Parameters
- a: Vector3
- b: Vector3
Returns number
squared distance between vectors.

Static div

div(v: Vector3, d: number): Vector3

- Defined in api.ts:636
Divides all components of vector v by divisor d.

Parameters
- v: Vector3
- d: number
Returns Vector3
new vector of the divided result.

Static dot

dot(a: Vector3, b: Vector3): number

- Defined in api.ts:556
Calculates the dot product of vector a and vector b.

The dot product is a number equal to the lengths of two vectors multiplied together and then multiplied by the cosine of the angle between them.

Parameters
- a: Vector3
- b: Vector3
Returns number
dot product.

Static equals

equals(a: Vector3, b: Vector3): boolean

- Defined in api.ts:619
Returns true if vector a equals vector b.

Parameters
- a: Vector3
  
  vector to compare.
- b: Vector3
  
  vector to compare.
Returns boolean

Static max

max(a: Vector3, b: Vector3): Vector3

- Defined in api.ts:629
Returns a vector made from the largest components of vector a and vector b.

Parameters
- a: Vector3
- b: Vector3
Returns Vector3

Static min

min(a: Vector3, b: Vector3): Vector3

- Defined in api.ts:624
Returns a vector made from the smallest components of vector a and vector b.

Parameters
- a: Vector3
- b: Vector3
Returns Vector3

Static mult

mult(v: Vector3, m: number): Vector3

- Defined in api.ts:525
Multiplies each component of vector v by m.

Parameters
- v: Vector3
  
  vector components to multiply.
- m: number
Returns Vector3
new vector of the multiplied result.

Static norm2

norm2(v: Vector3): number

- Defined in api.ts:594
Returns the length of vector v.

The length is made up from the square root of (x * x + y * y + z * z).

Parameters
- v: Vector3
Returns number
length of v

Static project

project(a: Vector3, b: Vector3): Vector3

- Defined in api.ts:574
Projects vector a onto vector b.

Parameters
- a: Vector3
- b: Vector3
Returns Vector3
vector projection

Static projectOnPlane

projectOnPlane(v: Vector3, normal: Vector3): Vector3

- Defined in api.ts:585
Projects vector v onto a plane defined by a normal that is orthogonal to it.

Parameters
- v: Vector3
  
  position of the vector above the plane.
- normal: Vector3
  
  direction from the vector towards the plane.
Returns Vector3
location of vector on the plane.

Static sub

sub(a: Vector3, b: Vector3): Vector3

- Defined in api.ts:539
Subtracts each component of vector b from a.

Parameters
- a: Vector3
- b: Vector3
Returns Vector3
new vector of the subtraction result.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

x: number

y: number

z: number

Returns Vector3

Properties

Readonly length

Readonly normalized

Readonly sqrLength

Readonly x

Readonly y

Readonly z

Static Readonly one

Static Readonly zero

Methods

add

Parameters

other: Vector3

Returns Vector3

angle

Parameters

other: Vector3

Returns number

cross

Parameters

other: Vector3

Returns Vector3

dist

Parameters

other: Vector3

Returns number

div

Parameters

d: number

Returns Vector3

dot

Parameters

other: Vector3

Returns number

equals

Parameters

v: Vector3

Returns boolean

limitLength

Parameters

l: number

Returns Vector3

max

Parameters

other: Vector3

Returns Vector3

min

Parameters

other: Vector3

Returns Vector3

mult

Parameters

m: number

Returns Vector3

project

Parameters

other: Vector3

Returns Vector3

projectOnPlane

Parameters

normal: Vector3

Returns Vector3

sub

Parameters

other: Vector3

Returns Vector3

toArray

Returns number[]