Class Vector3

Describes a 3D-vector.

Hierarchy

Vector3

Index

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
Constructor of Vector3.
Parameters
- x: number = 0
  
  The x component of the vector, default 0
- y: number = 0
  
  The y component of the vector, default 0
- z: number = 0
  
  The z component of the vector, default 0
Returns Vector3
- Defined in math/Vector3.ts:364

Properties

_onValueChanged

_onValueChanged: (() => void) = null

Type declaration

- (): void
- Internal
  Returns void

`Internal` _x

_x: number

`Internal` _y

_y: number

`Internal` _z

_z: number

`Static` `Readonly` `Internal` _one

_one: Vector3 = ...

`Static` `Readonly` `Internal` _zero

_zero: Vector3 = ...

Accessors

x

get x(): number
The x component of the vector.

Returns number
- Defined in math/Vector3.ts:325
set x(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector3.ts:329

y

get y(): number
The y component of the vector.

Returns number
- Defined in math/Vector3.ts:337
set y(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector3.ts:341

z

get z(): number
The z component of the vector.

Returns number
- Defined in math/Vector3.ts:349
set z(value: number): void
Parameters
- value: number
Returns void
- Defined in math/Vector3.ts:353

Methods

add

add(right: Vector3): Vector3
Determines the sum of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector3
  
  The specified vector
Returns Vector3
- Defined in math/Vector3.ts:404

clone

clone(): Vector3
Creates a clone of this vector.

Returns
A clone of this vector

Returns Vector3
- Defined in math/Vector3.ts:518

cloneTo

cloneTo(out: Vector3): Vector3
Clones this vector to the specified vector.

Returns
The specified vector
Parameters
- out: Vector3
  
  The specified vector
Returns Vector3
- Defined in math/Vector3.ts:527

divide

divide(right: Vector3): Vector3
Determines the divisor of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector3
  
  The specified vector
Returns Vector3
- Defined in math/Vector3.ts:443

length

length(): number
Calculate the length of this vector.

Returns
The length of this vector

Returns number
- Defined in math/Vector3.ts:455

lengthSquared

lengthSquared(): number
Calculate the squared length of this vector.

Returns
The squared length of this vector

Returns number
- Defined in math/Vector3.ts:464

multiply

multiply(right: Vector3): Vector3
Determines the product of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector3
  
  The specified vector
Returns Vector3
- Defined in math/Vector3.ts:430

negate

negate(): Vector3
Reverses the direction of this vector.

Returns
This vector

Returns Vector3
- Defined in math/Vector3.ts:473

normalize

normalize(): Vector3
Converts this vector into a unit vector.

Returns
This vector

Returns Vector3
- Defined in math/Vector3.ts:485

scale

scale(s: number): Vector3
Scale this vector by the given value.

Returns
This vector
Parameters
- s: number
  
  The amount by which to scale the vector
Returns Vector3
- Defined in math/Vector3.ts:495

setValue

setValue(x: number, y: number, z: number): Vector3
Set the value of this vector.

Returns
This vector
Parameters
- x: number
  
  The x component of the vector
- y: number
  
  The y component of the vector
- z: number
  
  The z component of the vector
Returns Vector3
- Defined in math/Vector3.ts:377

setValueByArray

setValueByArray(array: ArrayLike<number>, offset?: number): Vector3
Set the value of this vector by an array.

Returns
This vector
Parameters
- array: ArrayLike<number>
  
  The array
- offset: number = 0
  
  The start offset of the array
Returns Vector3
- Defined in math/Vector3.ts:391

subtract

subtract(right: Vector3): Vector3
Determines the difference of this vector and the specified vector.

Returns
This vector
Parameters
- right: Vector3
  
  The specified vector
Returns Vector3
- Defined in math/Vector3.ts:417

toArray

toArray(out: Float32Array | Float64Array | number[], outOffset?: number): void
Clone the value of this vector to an array.
Parameters
- out: Float32Array | Float64Array | number[]
  
  The array
- outOffset: number = 0
  
  The start offset of the array
Returns void
- Defined in math/Vector3.ts:508

transformByQuat

transformByQuat(quaternion: Quaternion): Vector3
This vector performs a transformation using the given quaternion.

Returns
This vector
Parameters
- quaternion: Quaternion
  
  The transform quaternion
Returns Vector3
- Defined in math/Vector3.ts:582

transformCoordinate

transformCoordinate(m: Matrix4): Vector3
This vector performs a coordinate transformation using the given 4x4 matrix.

Remarks
A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the w-component to be one and therefore makes the vector homogeneous. The homogeneous vector is often preferred when working with coordinates as the w component can safely be ignored.

Returns
This vector
Parameters
- m: Matrix4
  
  The transform matrix
Returns Vector3
- Defined in math/Vector3.ts:572

transformNormal

transformNormal(m: Matrix4): Vector3
This vector performs a normal transformation using the given 4x4 matrix.

Remarks
A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth column of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often preferred for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated.

Returns
This vector
Parameters
- m: Matrix4
  
  The transform matrix
Returns Vector3
- Defined in math/Vector3.ts:546

transformToVec3

transformToVec3(m: Matrix4): Vector3
This vector performs a transformation using the given 4x4 matrix.

Returns
This vector
Parameters
- m: Matrix4
  
  The transform matrix
Returns Vector3
- Defined in math/Vector3.ts:556

`Static` add

add(left: Vector3, right: Vector3, out: Vector3): void
Determines the sum of two vectors.
Parameters
- left: Vector3
  
  The first vector to add
- right: Vector3
  
  The second vector to add
- out: Vector3
  
  The sum of two vectors
Returns void
- Defined in math/Vector3.ts:21

`Static` cross

cross(left: Vector3, right: Vector3, out: Vector3): void
Determines the cross product of two vectors.
Parameters
- left: Vector3
  
  The first vector to cross
- right: Vector3
  
  The second vector to cross
- out: Vector3
  
  The cross product of two vectors
Returns void
- Defined in math/Vector3.ts:83

`Static` distance

distance(a: Vector3, b: Vector3): number
Determines the distance of two vectors.

Returns
The distance of two vectors
Parameters
- a: Vector3
  
  The first vector
- b: Vector3
  
  The second vector
Returns number
- Defined in math/Vector3.ts:100

`Static` distanceSquared

distanceSquared(a: Vector3, b: Vector3): number
Determines the squared distance of two vectors.

Returns
The squared distance of two vectors
Parameters
- a: Vector3
  
  The first vector
- b: Vector3
  
  The second vector
Returns number
- Defined in math/Vector3.ts:113

`Static` divide

divide(left: Vector3, right: Vector3, out: Vector3): void
Determines the divisor of two vectors.
Parameters
- left: Vector3
  
  The first vector to divide
- right: Vector3
  
  The second vector to divide
- out: Vector3
  
  The divisor of two vectors
Returns void
- Defined in math/Vector3.ts:60

`Static` dot

dot(left: Vector3, right: Vector3): number
Determines the dot product of two vectors.

Returns
The dot product of two vectors
Parameters
- left: Vector3
  
  The first vector to dot
- right: Vector3
  
  The second vector to dot
Returns number
- Defined in math/Vector3.ts:73

`Static` equals

equals(left: Vector3, right: Vector3): boolean
Determines whether the specified vectors are equals.

Returns
True if the specified vectors are equals, false otherwise
Parameters
- left: Vector3
  
  The first vector to compare
- right: Vector3
  
  The second vector to compare
Returns boolean
- Defined in math/Vector3.ts:126

`Static` lerp

lerp(start: Vector3, end: Vector3, t: number, out: Vector3): void
Performs a linear interpolation between two vectors.
Parameters
- start: Vector3
  
  The first vector
- end: Vector3
  
  The second vector
- t: number
  
  The blend amount where 0 returns start and 1 end
- out: Vector3
  
  The result of linear blending between two vectors
Returns void
- Defined in math/Vector3.ts:139

`Static` max

max(left: Vector3, right: Vector3, out: Vector3): void
Calculate a vector containing the largest components of the specified vectors.
Parameters
- left: Vector3
  
  The first vector
- right: Vector3
  
  The second vector
- out: Vector3
  
  The vector containing the largest components of the specified vectors
Returns void
- Defined in math/Vector3.ts:153

`Static` min

min(left: Vector3, right: Vector3, out: Vector3): void
Calculate a vector containing the smallest components of the specified vectors.
Parameters
- left: Vector3
  
  The first vector
- right: Vector3
  
  The second vector
- out: Vector3
  
  The vector containing the smallest components of the specified vectors
Returns void
- Defined in math/Vector3.ts:166

`Static` multiply

multiply(left: Vector3, right: Vector3, out: Vector3): void
Determines the product of two vectors.
Parameters
- left: Vector3
  
  The first vector to multiply
- right: Vector3
  
  The second vector to multiply
- out: Vector3
  
  The product of two vectors
Returns void
- Defined in math/Vector3.ts:47

`Static` negate

negate(a: Vector3, out: Vector3): void
Reverses the direction of a given vector.
Parameters
- a: Vector3
  
  The vector to negate
- out: Vector3
  
  The vector facing in the opposite direction
Returns void
- Defined in math/Vector3.ts:178

`Static` normalize

normalize(a: Vector3, out: Vector3): void
Converts the vector into a unit vector.
Parameters
- a: Vector3
  
  The vector to normalize
- out: Vector3
  
  The normalized vector
Returns void
- Defined in math/Vector3.ts:190

`Static` scale

scale(a: Vector3, s: number, out: Vector3): void
Scale a vector by the given value.
Parameters
- a: Vector3
  
  The vector to scale
- s: number
  
  The amount by which to scale the vector
- out: Vector3
  
  The scaled vector
Returns void
- Defined in math/Vector3.ts:205

`Static` subtract

subtract(left: Vector3, right: Vector3, out: Vector3): void
Determines the difference between two vectors.
Parameters
- left: Vector3
  
  The first vector to subtract
- right: Vector3
  
  The second vector to subtract
- out: Vector3
  
  The difference between two vectors
Returns void
- Defined in math/Vector3.ts:34

`Static` transformByQuat

transformByQuat(v: Vector3, quaternion: Quaternion, out: Vector3): void
Performs a transformation using the given quaternion.
Parameters
- v: Vector3
  
  The vector to transform
- quaternion: Quaternion
  
  The transform quaternion
- out: Vector3
  
  The transformed vector
Returns void
- Defined in math/Vector3.ts:296

`Static` transformCoordinate

transformCoordinate(v: Vector3, m: Matrix4, out: Vector3): void
Performs a coordinate transformation using the given 4x4 matrix.

Remarks
A coordinate transform performs the transformation with the assumption that the w component is one. The four dimensional vector obtained from the transformation operation has each component in the vector divided by the w component. This forces the w-component to be one and therefore makes the vector homogeneous. The homogeneous vector is often preferred when working with coordinates as the w component can safely be ignored.
Parameters
- v: Vector3
  
  The coordinate vector to transform
- m: Matrix4
  
  The transform matrix
- out: Vector3
  
  The transformed coordinates
Returns void
- Defined in math/Vector3.ts:278

`Static` transformNormal

transformNormal(v: Vector3, m: Matrix4, out: Vector3): void
Performs a normal transformation using the given 4x4 matrix.

Remarks
A normal transform performs the transformation with the assumption that the w component is zero. This causes the fourth row and fourth column of the matrix to be unused. The end result is a vector that is not translated, but all other transformation properties apply. This is often preferred for normal vectors as normals purely represent direction rather than location because normal vectors should not be translated.
Parameters
- v: Vector3
  
  The normal vector to transform
- m: Matrix4
  
  The transform matrix
- out: Vector3
  
  The transformed normal
Returns void
- Defined in math/Vector3.ts:224

`Static` transformToVec3

transformToVec3(v: Vector3, m: Matrix4, out: Vector3): void
Performs a transformation using the given 4x4 matrix.
Parameters
- v: Vector3
  
  The vector to transform
- m: Matrix4
  
  The transform matrix
- out: Vector3
  
  The transformed vector3
Returns void
- Defined in math/Vector3.ts:239

`Static` transformToVec4

transformToVec4(v: Vector3, m: Matrix4, out: Vector4): void
Performs a transformation from vector3 to vector4 using the given 4x4 matrix.
Parameters
- v: Vector3
  
  The vector to transform
- m: Matrix4
  
  The transform matrix
- out: Vector4
  
  The transformed vector4
Returns void
- Defined in math/Vector3.ts:255

Class Vector3

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

x: number = 0

y: number = 0

z: number = 0

Returns Vector3

Properties

_onValueChanged

Type declaration

Returns void

Internal _x

Internal _y

Internal _z

Static Readonly Internal _one

Static Readonly Internal _zero

Accessors

x

Returns number

Parameters

value: number

Returns void

y

Returns number

Parameters

value: number

Returns void

z

Returns number

Parameters

value: number

Returns void

Methods

add

Returns

Parameters

right: Vector3

Returns Vector3

clone

Returns

Returns Vector3

cloneTo

Returns

Parameters

out: Vector3

Returns Vector3

divide

Returns

Parameters

right: Vector3

Returns Vector3

length

Returns

Returns number

lengthSquared

Returns

Returns number

multiply

Returns

Parameters

right: Vector3

Returns Vector3

negate

Returns

Returns Vector3

normalize

Returns

Returns Vector3

scale

Returns

Parameters

s: number

Returns Vector3

`Internal` _x

`Internal` _y

`Internal` _z

`Static` `Readonly` `Internal` _one

`Static` `Readonly` `Internal` _zero

`Static` add

`Static` cross

`Static` distance

`Static` distanceSquared

`Static` divide