Vector3 | Math Library

表示三维的一个向量

Class representing a vector containing 3 coordinates

Hierarchy

Vector3

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
new Vector3(point?: Partial<IVec3>): Vector3

- Defined in unit/vector3/index.ts:75
Parameters
- Optional x: number
  
  x value
- Optional y: number
  
  y value
- Optional z: number
  
  z value
Returns Vector3
- Defined in unit/vector3/index.ts:82
Parameters
- Optional point: Partial<IVec3>
  
  An object that contains the values x, y and z
Returns Vector3

Properties

x

x: number = ...

向量的 x 值

The X value of the current vector

default: 0

y

y: number = ...

向量的 y 值

The Y value of the current vector

default: 0

z

z: number = ...

向量的 z 值

The Z value of the current vector

default: 0

Static Readonly MAX

MAX: Vector3 = ...

Vector3 (Infinity, Infinity, Infinity)

Static Readonly MIN

MIN: Vector3 = ...

Vector3 (-Infinity, -Infinity, -Infinity)

Static Readonly ONE

ONE: Vector3 = ...

Vector3 (1, 1, 1)

Static X_DIRECTION

X_DIRECTION: Vector3 = ...

X轴正方向

The positive direction of the X-Axis

Static Y_DIRECTION

Y_DIRECTION: Vector3 = ...

Y轴正方向

The positive direction of the Y-Axis

Static Readonly ZERO

ZERO: Vector3 = ...

Vector3 (0, 0, 0)

Static Z_DIRECTION

Z_DIRECTION: Vector3 = ...

Z轴正方向

The positive direction of the Z-Axis

Accessors

length

get length(): number

- Defined in unit/vector3/index.ts:180
向量的长度

Computes length of this vector.

Returns number

lengthSq

get lengthSq(): number

- Defined in unit/vector3/index.ts:189
向量长度的平方

Computes squared length of this vector.

Returns number

Methods

add

add(value: number): Vector3
add(vector: Partial<IVec3>): Vector3

- Defined in unit/vector3/index.ts:200
向量加法

Adds v with the current vector

Parameters
- value: number
  
  a scalar or a Vector3
Returns Vector3

A new Vector3
- Defined in unit/vector3/index.ts:201
Parameters
- vector: Partial<IVec3>
Returns Vector3

applyMatrix4

applyMatrix4(matrix: Matrix4): Vector3

- Defined in unit/vector3/index.ts:292
对当前向量应用矩阵

Apply matrix4 to the current vector

Parameters
- matrix: Matrix4
  
  A Matrix$
Returns Vector3

A new Vector3

clone

clone(): Vector3

- Defined in unit/vector3/index.ts:171
复制当前向量

Clones this vector to a new vector

Returns Vector3

copy

copy(v: Vector3): Vector3

- Defined in unit/vector3/index.ts:162
将向量 v 的值拷贝给当前向量

Copies v to this vector

Parameters
- v: Vector3
Returns Vector3

cross

cross(v: Vector3): Vector3

- Defined in unit/vector3/index.ts:343
叉乘

Computes cross product of this vector and v

Parameters
- v: Vector3
Returns Vector3

new Vector

divide

divide(value: number): Vector3
divide(vector: Partial<IVec3>): Vector3

- Defined in unit/vector3/index.ts:269
向量除法

Divides the current vector by v.

Parameters
- value: number
  
  a scalar or a Vector3
Returns Vector3

A new Vector3
- Defined in unit/vector3/index.ts:270
Parameters
- vector: Partial<IVec3>
Returns Vector3

dot

dot(v: Vector3): number

- Defined in unit/vector3/index.ts:332
点乘

Computes dot product of this vector and v

Parameters
- v: Vector3
Returns number

equals

equals(v: Vector3): boolean

- Defined in unit/vector3/index.ts:356
两个向量是否相等

Determines whether this vector and v are equal

Parameters
- v: Vector3
Returns boolean

inverse

inverse(): Vector3

- Defined in unit/vector3/index.ts:312
逆向量

Inverse the current vector

Returns Vector3

A new Vector3

isOrthogonal

isOrthogonal(v: Vector3): boolean

- Defined in unit/vector3/index.ts:383
两个向量是否正交垂直

Determines whether this vector and v are orthogonal

Parameters
- v: Vector3
Returns boolean

isParallel

isParallel(v: Vector3): boolean

- Defined in unit/vector3/index.ts:366
两个向量是否平行

Determines whether this vector and v are parallel

Parameters
- v: Vector3
Returns boolean

multiply

multiply(value: number): Vector3
multiply(vector: Partial<IVec3>): Vector3

- Defined in unit/vector3/index.ts:246
向量乘法

Multiplies the current vector by v.

Parameters
- value: number
  
  a scalar or a Vector3
Returns Vector3

A new Vector3
- Defined in unit/vector3/index.ts:247
Parameters
- vector: Partial<IVec3>
Returns Vector3

normalize

normalize(): Vector3

- Defined in unit/vector3/index.ts:323
单位向量

Normalizes this vector.

Returns Vector3

A new Vector3

set

set(x?: number, y?: number, z?: number): Vector3
set(point: Partial<IVec3>): Vector3

- Defined in unit/vector3/index.ts:101
设置向量的值

Sets values of the current vector

Parameters
- Optional x: number
  
  x value
- Optional y: number
  
  y value
- Optional z: number
  
  z value
Returns Vector3

当前向量 (this vector3)
- Defined in unit/vector3/index.ts:109
设置向量的值

Sets values of the current vector

Parameters
- point: Partial<IVec3>
  
  An object that contains the values x, y and z
Returns Vector3

当前向量 (this vector3)

setX

setX(x: number): Vector3

- Defined in unit/vector3/index.ts:130
设置向量的 x 值

Sets the x value of the current vector

Parameters
- x: number
Returns Vector3

当前向量 (this vector3)

setY

setY(y: number): Vector3

- Defined in unit/vector3/index.ts:141
设置向量的 y 值

Sets the y value of the current vector

Parameters
- y: number
Returns Vector3

当前向量 (this vector3)

setZ

setZ(z: number): Vector3

- Defined in unit/vector3/index.ts:152
设置向量的 z 值

Sets the z value of the current vector

Parameters
- z: number
Returns Vector3

当前向量 (this vector3)

sub

sub(value: number): Vector3
sub(vector: Partial<IVec3>): Vector3

- Defined in unit/vector3/index.ts:223
向量减法

Subtracts v from the current vector

Parameters
- value: number
  
  a scalar or a Vector3
Returns Vector3

A new Vector3
- Defined in unit/vector3/index.ts:224
Parameters
- vector: Partial<IVec3>
Returns Vector3

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional x: number

Optional y: number

Optional z: number

Returns Vector3

Parameters

Optional point: Partial<IVec3>

Returns Vector3

Properties

x

y

z

Static Readonly MAX

Static Readonly MIN

Static Readonly ONE

Static X_DIRECTION

Static Y_DIRECTION

Static Readonly ZERO

Static Z_DIRECTION

Accessors

length

Returns number

lengthSq

Returns number

Methods

add

Parameters

value: number

Returns Vector3

Parameters

vector: Partial<IVec3>

Returns Vector3

applyMatrix4

Parameters

matrix: Matrix4

Returns Vector3

clone

Returns Vector3

copy

Parameters

v: Vector3

Returns Vector3

cross

Parameters

v: Vector3

Returns Vector3

divide

Parameters

value: number

Returns Vector3

Parameters

vector: Partial<IVec3>

Returns Vector3

dot

Parameters

v: Vector3

Returns number

equals

Parameters

v: Vector3

Returns boolean

inverse

Returns Vector3

isOrthogonal

Parameters

v: Vector3

Returns boolean

isParallel

Parameters

v: Vector3

Returns boolean

multiply