Class Vector3

Vector3 类使用笛卡尔坐标 x、y 和 z 表示三维空间中的点或位置

Hierarchy

Vector3

Implements

Vector
Vector3Like

Constructors

constructor

new Vector3(x?: number, y?: number, z?: number): Vector3
创建 Vector3 对象的实例。如果未指定构造函数的参数，则将使用元素 (0,0,0,0) 创建 Vector3 对象。
Parameters
- x: number = 0
  
  第一个元素，例如 x 坐标。
- y: number = 0
  
  第二个元素，例如 y 坐标。
- z: number = 0
  
  第三个元素，例如 z 坐标。
Returns Vector3
- Defined in src/math/geom/Vector3.ts:117

Properties

class

__class__: "Vector3"

x

x: number = 0

Vector3 对象中的第一个元素，例如，三维空间中某个点的 x 坐标。默认值为 0

y

y: number = 0

Vector3 对象中的第二个元素，例如，三维空间中某个点的 y 坐标。默认值为 0

z

z: number = 0

Vector3 对象中的第三个元素，例如，三维空间中某个点的 z 坐标。默认值为 0

`Static` `Private` _ONE

_ONE: Readonly<Vector3>

`Static` `Private` _X_AXIS

_X_AXIS: Readonly<Vector3>

`Static` `Private` _Y_AXIS

_Y_AXIS: Readonly<Vector3>

`Static` `Private` _ZERO

_ZERO: Readonly<Vector3>

`Static` `Private` _Z_AXIS

_Z_AXIS: Readonly<Vector3>

Accessors

length

get length(): number
当前 Vector3 对象的长度（大小），即从原点 (0,0,0) 到该对象的 x、y 和 z 坐标的距离。w 属性将被忽略。单位矢量具有的长度或大小为一。

Returns number
- Defined in src/math/geom/Vector3.ts:98

lengthSquared

get lengthSquared(): number
当前 Vector3 对象长度的平方，它是使用 x、y 和 z 属性计算出来的。w 属性将被忽略。尽可能使用 lengthSquared() 方法，而不要使用 Vector3.length() 方法的 Math.sqrt() 方法调用，后者速度较慢。

Returns number
- Defined in src/math/geom/Vector3.ts:106

`Static` ONE

get ONE(): Readonly<Vector3>
Vector3(1, 1, 1)

Returns Readonly<Vector3>
- Defined in src/math/geom/Vector3.ts:68

`Static` X_AXIS

get X_AXIS(): Readonly<Vector3>
定义为 Vector3 对象的 x 轴，坐标为 (1,0,0)。

Returns Readonly<Vector3>
- Defined in src/math/geom/Vector3.ts:32

`Static` Y_AXIS

get Y_AXIS(): Readonly<Vector3>
定义为 Vector3 对象的 y 轴，坐标为 (0,1,0)

Returns Readonly<Vector3>
- Defined in src/math/geom/Vector3.ts:41

`Static` ZERO

get ZERO(): Readonly<Vector3>
原点 Vector3(0,0,0)

Returns Readonly<Vector3>
- Defined in src/math/geom/Vector3.ts:59

`Static` Z_AXIS

get Z_AXIS(): Readonly<Vector3>
定义为 Vector3 对象的 z 轴，坐标为 (0,0,1)

Returns Readonly<Vector3>
- Defined in src/math/geom/Vector3.ts:50

Methods

add

add(v: Vector3): Vector3
加上指定向量
Parameters
- v: Vector3
  
  加向量
Returns Vector3
Implementation of Vector.add
- Defined in src/math/geom/Vector3.ts:215

addNumber

addNumber(n: number): Vector3
加上标量
Parameters
- n: number
  
  标量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:540

addNumberTo

addNumberTo(n: number, vOut?: Vector3): Vector3
增加标量
Parameters
- n: number
  
  标量
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:553

addScaledVector

addScaledVector(scalar: number, vector: Vector3): Vector3
Scale a vector and add it to this vector. Save the result in "this". (this = this + vector * scalar)
Parameters
- scalar: number
- vector: Vector3
Returns Vector3
- Defined in src/math/geom/Vector3.ts:412

addScaledVectorTo

addScaledVectorTo(scalar: number, vector: Vector3Like, target?: Vector3): Vector3
Scale a vector and add it to this vector. Save the result in "target". (target = this + vector * scalar)
Parameters
- scalar: number
- vector: Vector3Like
- target: Vector3 = ...
  
  The vector to save the result in.
Returns Vector3
- Defined in src/math/geom/Vector3.ts:427

addTo

addTo(v: Vector3, vOut?: Vector3): Vector3
加上指定向量得到新向量

Returns
返回新向量
Parameters
- v: Vector3
  
  加向量
- vOut: Vector3 = ...
Returns Vector3
Implementation of Vector.addTo
- Defined in src/math/geom/Vector3.ts:229

almostZero

almostZero(precision?: number): boolean
检查一个向量是否接近零
Parameters
- precision: number = mathUtil.PRECISION
Returns boolean
- Defined in src/math/geom/Vector3.ts:509

applyMatrix4x4

applyMatrix4x4(mat: Matrix4x4): Vector3
应用矩阵
Parameters
- mat: Matrix4x4
  
  矩阵
Returns Vector3
- Defined in src/math/geom/Vector3.ts:1041

applyQuaternion

applyQuaternion(q: Quaternion): Vector3
应用四元素
Parameters
- q: Quaternion
  
  四元素
Returns Vector3
- Defined in src/math/geom/Vector3.ts:1011

ceil

ceil(): Vector3
向上取整

Returns Vector3
- Defined in src/math/geom/Vector3.ts:952

clamp

clamp(min: Vector3, max: Vector3): Vector3
夹紧？
Parameters
- min: Vector3
  
  最小值
- max: Vector3
  
  最大值
Returns Vector3
- Defined in src/math/geom/Vector3.ts:883

clampTo

clampTo(min: Vector3, max: Vector3, vOut?: Vector3): Vector3
夹紧？
Parameters
- min: Vector3
  
  最小值
- max: Vector3
  
  最大值
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:897

clone

clone(): Vector3
返回一个新 Vector3 对象，它是与当前 Vector3 对象完全相同的副本。

Returns
一个新 Vector3 对象，它是当前 Vector3 对象的副本。

Returns Vector3
- Defined in src/math/geom/Vector3.ts:646

copy

copy(v: Vector3Like): Vector3
将源 Vector3 对象中的所有矢量数据复制到调用方 Vector3 对象中。

Returns
要从中复制数据的 Vector3 对象。
Parameters
- v: Vector3Like
Returns Vector3
Implementation of Vector.copy
- Defined in src/math/geom/Vector3.ts:345

cross

cross(a: Vector3Like): Vector3
叉乘向量
Parameters
- a: Vector3Like
  
  向量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:440

crossMat

crossMat(this: Vector3, outMatrix: Matrix3x3): Matrix3x3
从向量中得到叉乘矩阵a_cross，使得a x b = a_cross * b = c

See
http://www8.cs.umu.se/kurser/TDBD24/VT06/lectures/Lecture6.pdf
Parameters
- this: Vector3
- outMatrix: Matrix3x3
Returns Matrix3x3
- Defined in src/math/geom/Vector3.ts:998

crossTo

crossTo(a: Vector3Like, vOut?: Vector3): Vector3
叉乘向量
Parameters
- a: Vector3Like
  
  向量
- vOut: Vector3 = ...
  
  输出向量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:450

distance

distance(p: Vector3Like): number
与目标点之间的距离
Parameters
- p: Vector3Like
  
  目标点
Returns number
Implementation of Vector.distance
- Defined in src/math/geom/Vector3.ts:358

distanceSquared

distanceSquared(p: Vector3Like): number
与目标点之间的距离平方
Parameters
- p: Vector3Like
  
  目标点
Returns number
Implementation of Vector.distanceSquared
- Defined in src/math/geom/Vector3.ts:371

divide

divide(a: Vector3): Vector3
除以向量
Parameters
- a: Vector3
  
  向量
Returns Vector3
Implementation of Vector.divide
- Defined in src/math/geom/Vector3.ts:297

divideNumber

divideNumber(n: number): Vector3
除以标量
Parameters
- n: number
  
  标量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:619

divideNumberTo

divideNumberTo(n: number, vOut?: Vector3): Vector3
除以标量
Parameters
- n: number
  
  标量
- vOut: Vector3 = ...
  
  输出向量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:633

divideTo

divideTo(a: Vector3Like, vOut?: Vector3): Vector3
除以向量
Parameters
- a: Vector3Like
  
  向量
- vOut: Vector3 = ...
  
  输出向量
Returns Vector3
Implementation of Vector.divideTo
- Defined in src/math/geom/Vector3.ts:311

dot

dot(a: Vector3Like): number
如果当前 Vector3 对象和作为参数指定的 Vector3 对象均为单位顶点，此方法将返回这两个顶点之间所成角的余弦值。
Parameters
- a: Vector3Like
Returns number
- Defined in src/math/geom/Vector3.ts:462

equals

equals(v: Vector3Like, precision?: number): boolean
通过将当前 Vector3 对象的 x、y 和 z 元素与指定的 Vector3 对象的 x、y 和 z 元素进行比较，确定这两个对象是否相等。
Parameters
- v: Vector3Like
- precision: number = mathUtil.PRECISION
Returns boolean
Implementation of Vector.equals
- Defined in src/math/geom/Vector3.ts:323

floor

floor(): Vector3
向下取整

Returns Vector3
- Defined in src/math/geom/Vector3.ts:940

fromArray

fromArray(array: ArrayLike<number>, offset?: number): Vector3
从数组中初始化向量

Returns
返回新向量
Parameters
- array: ArrayLike<number>
  
  数组
- offset: number = 0
  
  偏移
Returns Vector3
- Defined in src/math/geom/Vector3.ts:176

fromVector2

fromVector2(vector: Vector2, z?: number): Vector3
从Vector2初始化
Parameters
- vector: Vector2
- z: number = 0
Returns Vector3
- Defined in src/math/geom/Vector3.ts:147

fromVector4

fromVector4(vector: Vector4): Vector3
从Vector4初始化
Parameters
- vector: Vector4
  
  4维向量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:161

greater

greater(p: Vector3): boolean
大于指定点
Parameters
- p: Vector3
  
  点
Returns boolean
- Defined in src/math/geom/Vector3.ts:864

greaterEqual

greaterEqual(p: Vector3): boolean
大于等于指定点
Parameters
- p: Vector3
  
  点
Returns boolean
- Defined in src/math/geom/Vector3.ts:873

inverse

inverse(): Vector3
倒向量 (a,b,c)->(1/a,1/b,1/c)

Returns Vector3
- Defined in src/math/geom/Vector3.ts:681

inverseTo

inverseTo(vOut?: Vector3): Vector3
倒向量 (a,b,c)->(1/a,1/b,1/c)
Parameters
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:694

isAntiparallelTo

isAntiparallelTo(v: Vector3, precision?: number): boolean
检查这个向量是否与另一个向量反平行。
Parameters
- v: Vector3
- precision: number = mathUtil.PRECISION
  
  设置为零以进行精确比较
Returns boolean
- Defined in src/math/geom/Vector3.ts:527

isParallel

isParallel(v: Vector3, precision?: number): boolean
与指定向量是否平行
Parameters
- v: Vector3
  
  向量
- precision: number = mathUtil.PRECISION
Returns boolean
- Defined in src/math/geom/Vector3.ts:989

isZero

isZero(): boolean
是否为零向量

Returns boolean
- Defined in src/math/geom/Vector3.ts:470

lerp

lerp(v: Vector3, alpha: Vector3): Vector3
插值到指定向量

Returns
返回自身
Parameters
- v: Vector3
  
  目标向量
- alpha: Vector3
  
  插值系数
Returns Vector3
- Defined in src/math/geom/Vector3.ts:788

lerpNumber

lerpNumber(v: Vector3, alpha: number): Vector3
插值到指定向量

Returns
返回自身
Parameters
- v: Vector3
  
  目标向量
- alpha: number
  
  插值系数
Returns Vector3
- Defined in src/math/geom/Vector3.ts:818

lerpNumberTo

lerpNumberTo(v: Vector3, alpha: number, vOut?: Vector3): Vector3
插值到指定向量

Returns
返回自身
Parameters
- v: Vector3
  
  目标向量
- alpha: number
  
  插值系数
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:833

lerpTo

lerpTo(v: Vector3, alpha: Vector3, vOut?: Vector3): Vector3
插值到指定向量

Returns
返回自身
Parameters
- v: Vector3
  
  目标向量
- alpha: Vector3
  
  插值系数
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:803

less

less(p: Vector3): boolean
小于指定点
Parameters
- p: Vector3
  
  点
Returns boolean
- Defined in src/math/geom/Vector3.ts:846

lessEqual

lessEqual(p: Vector3): boolean
小于等于指定点
Parameters
- p: Vector3
  
  点
Returns boolean
- Defined in src/math/geom/Vector3.ts:855

max

max(v: Vector3): Vector3
取最大元素
Parameters
- v: Vector3
  
  向量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:919

min

min(v: Vector3): Vector3
取最小元素
Parameters
- v: Vector3
  
  向量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:906

multiply

multiply(v: Vector3): Vector3
乘以向量
Parameters
- v: Vector3
  
  向量
Returns Vector3
Implementation of Vector.multiply
- Defined in src/math/geom/Vector3.ts:270

multiplyNumber

multiplyNumber(n: number): Vector3
乘以标量
Parameters
- n: number
  
  标量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:592

multiplyNumberTo

multiplyNumberTo(n: number, vOut?: Vector3): Vector3
乘以标量
Parameters
- n: number
  
  标量
- vOut: Vector3 = ...
  
  输出向量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:606

multiplyTo

multiplyTo(v: Vector3, vOut?: Vector3): Vector3
乘以向量
Parameters
- v: Vector3
  
  向量
- vOut: Vector3 = ...
  
  输出向量
Returns Vector3
Implementation of Vector.multiplyTo
- Defined in src/math/geom/Vector3.ts:284

negate

negate(): Vector3
负向量 (a,b,c)->(-a,-b,-c)

Returns Vector3
- Defined in src/math/geom/Vector3.ts:655

negateTo

negateTo(vOut?: Vector3): Vector3
负向量 (a,b,c)->(-a,-b,-c)
Parameters
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:668

normalize

normalize(thickness?: number): Vector3
通过将最前面的三个元素（x、y、z）除以矢量的长度可将 Vector3 对象转换为单位矢量。
Parameters
- thickness: number = 1
Returns Vector3
Implementation of Vector.normalize
- Defined in src/math/geom/Vector3.ts:383

random

random(size?: number, double?: boolean): Vector3
随机三维向量
Parameters
- size: number = 1
  
  尺寸
- double: boolean = false
  
  如果值为false，随机范围在[0,size],否则[-size,size]。默认为false。
Returns Vector3
- Defined in src/math/geom/Vector3.ts:191

reflect

reflect(normal: Vector3): Vector3
反射
Parameters
- normal: Vector3
Returns Vector3
- Defined in src/math/geom/Vector3.ts:932

round

round(): Vector3
四舍五入

Returns Vector3
- Defined in src/math/geom/Vector3.ts:964

roundToZero

roundToZero(): Vector3
向0取整

Returns Vector3
- Defined in src/math/geom/Vector3.ts:976

scale

scale(s: Vector3): Vector3
缩放
Parameters
- s: Vector3
  
  缩放量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:760

scaleNumber

scaleNumber(s: number): Vector3
按标量（大小）缩放当前的 Vector3 对象。
Parameters
- s: number
Returns Vector3
- Defined in src/math/geom/Vector3.ts:735

scaleNumberTo

scaleNumberTo(s: number, vOut?: Vector3): Vector3
按标量（大小）缩放当前的 Vector3 对象。
Parameters
- s: number
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:747

scaleTo

scaleTo(s: Vector3, vOut?: Vector3): Vector3
缩放
Parameters
- s: Vector3
  
  缩放量
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:773

set

set(x: number, y: number, z: number): Vector3
将 Vector3 的成员设置为指定值
Parameters
- x: number
- y: number
- z: number
Returns Vector3
- Defined in src/math/geom/Vector3.ts:127

setZero

setZero(): void
把所有分量都设为零

Returns void
- Defined in src/math/geom/Vector3.ts:139

sub

sub(a: Vector3): Vector3
减去向量

Returns
返回新向量
Parameters
- a: Vector3
  
  减去的向量
Returns Vector3
Implementation of Vector.sub
- Defined in src/math/geom/Vector3.ts:243

subNumber

subNumber(n: number): Vector3
减去标量
Parameters
- n: number
  
  标量
Returns Vector3
- Defined in src/math/geom/Vector3.ts:566

subNumberTo

subNumberTo(n: number, vOut?: Vector3): Vector3
减去标量
Parameters
- n: number
  
  标量
- vOut: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:579

subTo

subTo(v: Vector3, vOut?: Vector3): Vector3
减去向量返回新向量

Returns
返回的新向量
Parameters
- v: Vector3
  
  减去的向量
- vOut: Vector3 = ...
Returns Vector3
Implementation of Vector.subTo
- Defined in src/math/geom/Vector3.ts:257

tangents

tangents(t1: Vector3, t2: Vector3): void
Parameters
- t1: Vector3
- t2: Vector3
Returns void
- Defined in src/math/geom/Vector3.ts:475

toArray

toArray(array?: number[], offset?: number): number[]
转换为数组

Returns
返回数组
Parameters
- array: number[] = []
  
  数组
- offset: number = 0
  
  偏移
Returns number[]
- Defined in src/math/geom/Vector3.ts:1062

toString

toString(): string
返回当前 Vector3 对象的字符串表示形式。

Returns string
- Defined in src/math/geom/Vector3.ts:1051

toVector2

toVector2(vector?: Vector2): Vector2
转换为Vector2
Parameters
- vector: Vector2 = ...
Returns Vector2
- Defined in src/math/geom/Vector3.ts:206

unit

unit(target?: Vector3): Vector3
得到这个向量长度为1
Parameters
- target: Vector3 = ...
Returns Vector3
- Defined in src/math/geom/Vector3.ts:706

Class Vector3

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

x: number = 0

y: number = 0

z: number = 0

Returns Vector3

Properties

__class__

x

y

z

Static Private _ONE

Static Private _X_AXIS

Static Private _Y_AXIS

Static Private _ZERO

Static Private _Z_AXIS

Accessors

length

Returns number

lengthSquared

Returns number

Static ONE

Returns Readonly<Vector3>

Static X_AXIS

Returns Readonly<Vector3>

Static Y_AXIS

Returns Readonly<Vector3>

Static ZERO

Returns Readonly<Vector3>

Static Z_AXIS

Returns Readonly<Vector3>

Methods

add

Parameters

v: Vector3

Returns Vector3

addNumber

Parameters

n: number

Returns Vector3

addNumberTo

Parameters

n: number

vOut: Vector3 = ...

Returns Vector3

addScaledVector

Parameters

scalar: number

vector: Vector3

Returns Vector3

addScaledVectorTo

Parameters

scalar: number

vector: Vector3Like

target: Vector3 = ...

Returns Vector3

addTo

Returns

Parameters

v: Vector3

vOut: Vector3 = ...

Returns Vector3

almostZero

Parameters

precision: number = mathUtil.PRECISION

Returns boolean

applyMatrix4x4

Parameters

mat: Matrix4x4

Returns Vector3

applyQuaternion

class

`Static` `Private` _ONE

`Static` `Private` _X_AXIS

`Static` `Private` _Y_AXIS

`Static` `Private` _ZERO

`Static` `Private` _Z_AXIS

`Static` ONE

`Static` X_AXIS

`Static` Y_AXIS

`Static` ZERO

`Static` Z_AXIS