Class Vector3Utils

Utilities operating on Vector3 objects. All methods are static and do not modify the input objects.

Hierarchy

Vector3Utils

Index

Constructors

Methods

add clamp cross dot equals floor magnitude normalize scale subtract toString

Constructors

constructor

new Vector3Utils(): Vector3Utils
Returns Vector3Utils

Methods

`Static` add

add(v1, v2): Vector3
add

Add two vectors to produce a new vector
Parameters
- v1: Vector3
- v2: Vector3
Returns Vector3
- Defined in math.d.ts:265

`Static` clamp

clamp(v, limits?): Vector3
clamp

Clamps the components of a vector to limits to produce a new vector
Parameters
- v: Vector3
- Optional limits: {
  max?: Partial<Vector3>;
  min?: Partial<Vector3>;
  }
  - Optional max?: Partial<Vector3>
  - Optional min?: Partial<Vector3>
Returns Vector3
- Defined in math.d.ts:321

`Static` cross

cross(a, b): Vector3
cross

Calculate the cross product of two vectors. Returns a new vector.
Parameters
- a: Vector3
- b: Vector3
Returns Vector3
- Defined in math.d.ts:288

`Static` dot

dot(a, b): number
dot

Calculate the dot product of two vectors
Parameters
- a: Vector3
- b: Vector3
Returns number
- Defined in math.d.ts:282

`Static` equals

equals(v1, v2): boolean
equals

Check the equality of two vectors
Parameters
- v1: Vector3
- v2: Vector3
Returns boolean
- Defined in math.d.ts:259

`Static` floor

floor(v): Vector3
floor

Floor the components of a vector to produce a new vector
Parameters
- v: Vector3
Returns Vector3
- Defined in math.d.ts:306

`Static` magnitude

magnitude(v): number
magnitude

The magnitude of a vector
Parameters
- v: Vector3
Returns number
- Defined in math.d.ts:294

`Static` normalize

normalize(v): Vector3
normalize

Takes a vector 3 and normalizes it to a unit vector
Parameters
- v: Vector3
Returns Vector3
- Defined in math.d.ts:300

`Static` scale

scale(v1, scale): Vector3
scale

Multiple all entries in a vector by a single scalar value producing a new vector
Parameters
- v1: Vector3
- scale: number
Returns Vector3
- Defined in math.d.ts:276

`Static` subtract

subtract(v1, v2): Vector3
subtract

Subtract two vectors to produce a new vector (v1-v2)
Parameters
- v1: Vector3
- v2: Vector3
Returns Vector3
- Defined in math.d.ts:271

`Static` toString

toString(v, options?): string
toString

Create a string representation of a vector3
Parameters
- v: Vector3
- Optional options: {
  decimals?: number;
  delimiter?: string;
  }
  - Optional decimals?: number
  - Optional delimiter?: string
Returns string
- Defined in math.d.ts:312