Class Vector3

Hierarchy

Vector3
- Vector3_READONLY

Index

Constructors

constructor

Properties

Accessors

x
y
z

Constructors

constructor

new Vector3(raw?: Float32Array, offset?: number): Vector3

- Defined in src/engine/math/vector3.ts:97
Parameters
- Optional raw: Float32Array
- Optional offset: number
Returns Vector3

Properties

Static Readonly ForwardLH

ForwardLH: DeepImmutableObject<Vector3>

前方向，基于左手坐标系，不要对该对象进行修改

static
memberof: Vector3

Static Readonly ONE

ONE: DeepImmutableObject<Vector3>

一向量，不要对该对象进行修改

readonly
static
memberof: Vector3

Static Readonly Up

Up: DeepImmutableObject<Vector3>

上方向，不要对该对象进行修改

static
memberof: Vector3

Static Readonly ZERO

ZERO: DeepImmutableObject<Vector3>

零向量，不要对该对象进行修改

readonly
static
memberof: Vector3

Accessors

x

get x(): number
set x(val: number): void

- Defined in src/engine/math/vector3.ts:21
x值

memberof

Vector3

Returns number
- Defined in src/engine/math/vector3.ts:24
x值

Parameters
- val: number
Returns void

y

get y(): number
set y(val: number): void

- Defined in src/engine/math/vector3.ts:34
y值

memberof

Vector3

Returns number
- Defined in src/engine/math/vector3.ts:37
y值

Parameters
- val: number
Returns void

z

get z(): number
set z(val: number): void

- Defined in src/engine/math/vector3.ts:48
z值

memberof

Vector3

Returns number
- Defined in src/engine/math/vector3.ts:51
z值

Parameters
- val: number
Returns void

Methods

add

add(v: DeepImmutableObject<Vector3>, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:232
向量加法

memberof

Vector3

Parameters
- v: DeepImmutableObject<Vector3>
  
  目标向量
- Optional dst: Vector3
Returns Vector3

计算结果

angleTo

angleTo(location: DeepImmutableObject<Vector3>, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:399
获取到目标点的角度

memberof

Vector3

Parameters
- location: DeepImmutableObject<Vector3>
  
  目标点
- Optional dst: Vector3
Returns Vector3

计算结果

applyMatrix4

applyMatrix4(m: DeepImmutableObject<Matrix4>): Vector3

- Defined in src/engine/math/vector3.ts:451
create by janzen
Multiplies this vector (with an implicit 1 in the 4th dimension) and m, and divides by perspective.

Parameters
- m: DeepImmutableObject<Matrix4>
Returns Vector3

applyQuaternion

applyQuaternion(q: DeepImmutableObject<Quaternion>): Vector3

- Defined in src/engine/math/vector3.ts:455
Parameters
- q: DeepImmutableObject<Quaternion>
Returns Vector3

clone

clone(): Vector3

- Defined in src/engine/math/vector3.ts:367
拷贝该向量

memberof

Vector3

Returns Vector3

拷贝出来的对象

cross

cross(v: DeepImmutableObject<Vector3>, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:258
向量叉乘

memberof

Vector3

Parameters
- v: DeepImmutableObject<Vector3>
  
  目标向量
- Optional dst: Vector3
Returns Vector3

计算结果

distanceTo

distanceTo(p: DeepImmutableObject<Vector3>): number

- Defined in src/engine/math/vector3.ts:389
获取到目标点的距离

memberof

Vector3

Parameters
- p: DeepImmutableObject<Vector3>
  
  目标点
Returns number

计算结果

dot

dot(v: DeepImmutableObject<Vector3>): number

- Defined in src/engine/math/vector3.ts:349
向量点乘

memberof

Vector3

Parameters
- v: DeepImmutableObject<Vector3>
  
  目标向量
Returns number

计算结果

equal

equal(v: DeepImmutableObject<Vector3>): boolean

- Defined in src/engine/math/vector3.ts:191
判断与目标向量的值是否相等

memberof

Vector3

Parameters
- v: DeepImmutableObject<Vector3>
  
  目标向量
Returns boolean

是否相等，这里误差小于10^-6视为相等

fromArray

fromArray(array: DeepImmutableObject<Float32Array>, offset: number): Vector3

- Defined in src/engine/math/vector3.ts:410
Parameters
- array: DeepImmutableObject<Float32Array>
- offset: number
Returns Vector3

fromPhysics

fromPhysics(v: RawVec3f): Vector3

- Defined in src/engine/math/vector3.ts:503
Parameters
- v: RawVec3f
Returns Vector3

isZero

isZero(): boolean

- Defined in src/engine/math/vector3.ts:378
是否为零向量

memberof

Vector3

Returns boolean

length

length(): number

- Defined in src/engine/math/vector3.ts:358
向量的模

memberof

Vector3

Returns number

计算结果

lerp

lerp(v: DeepImmutableObject<Vector3>, f: number, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:313
在该向量与目标向量之间计算插值

memberof

Vector3

Parameters
- v: DeepImmutableObject<Vector3>
  
  目标向量
- f: number
  
  插值系数
- Optional dst: Vector3
Returns Vector3

计算结果

negate

negate(): Vector3

- Defined in src/engine/math/vector3.ts:335
取反

Returns Vector3

normalize

normalize(dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:270
向量归一化

memberof

Vector3

Parameters
- Optional dst: Vector3
Returns Vector3

计算结果

project

project(camera: any): Vector3

- Defined in src/engine/math/vector3.ts:319
Parameters
- camera: any
Returns Vector3

scale

scale(f: number, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:283
向量缩放

memberof

Vector3

Parameters
- f: number
  
  缩放比
- Optional dst: Vector3
Returns Vector3

计算结果

scaleXYZ

scaleXYZ(x: number, y: number, z: number, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:298
向量缩放

memberof

Vector3

Parameters
- x: number
  
  x缩放比
- y: number
  
  y缩放比
- z: number
  
  z缩放比
- Optional dst: Vector3
Returns Vector3

计算结果

set

set(v: DeepImmutableObject<Vector3>): Vector3

- Defined in src/engine/math/vector3.ts:202
拷贝目标向量的值到该向量

memberof

Vector3

Parameters
- v: DeepImmutableObject<Vector3>
Returns Vector3

自身

setFromMatrixColumn

setFromMatrixColumn(m: DeepImmutableObject<Matrix4>, index: number): Vector3

- Defined in src/engine/math/vector3.ts:406
Parameters
- m: DeepImmutableObject<Matrix4>
- index: number
Returns Vector3

setFromMatrixPosition

setFromMatrixPosition(worldMatrix: DeepImmutableObject<Matrix4>): Vector3

- Defined in src/engine/math/vector3.ts:437
create by janzen
Sets this vector to the position elements of the transformation matrix

Parameters
- worldMatrix: DeepImmutableObject<Matrix4>
Returns Vector3

setFromMatrixScale

setFromMatrixScale(m: DeepImmutableObject<Matrix4>): Vector3

- Defined in src/engine/math/vector3.ts:421
Parameters
- m: DeepImmutableObject<Matrix4>
Returns Vector3

setValue

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

- Defined in src/engine/math/vector3.ts:216
设置向量的值

memberof

Vector3

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

自身

sub

sub(v: DeepImmutableObject<Vector3>, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:245
向量减法

memberof

Vector3

Parameters
- v: DeepImmutableObject<Vector3>
  
  目标向量
- Optional dst: Vector3
Returns Vector3

计算结果

toArray

toArray(): number[]

- Defined in src/engine/math/vector3.ts:180
返回向量数据

memberof

Vector3

Returns number[]

矩阵数据，以JSArray返回

toPhysics

toPhysics(): RawVec3f

- Defined in src/engine/math/vector3.ts:525
created by shanexyzhou
生成物理引擎内的RawVec3f

Returns RawVec3f

transformDirection

transformDirection(m: DeepImmutableObject<Matrix4>): Vector3

- Defined in src/engine/math/vector3.ts:479
create by janzen
Transforms the direction of this vector by a matrix (the upper left 3 x 3 subset of a m) and then normalizes the result.

Parameters
- m: DeepImmutableObject<Matrix4>
Returns Vector3

unproject

unproject(camera: any): Vector3

- Defined in src/engine/math/vector3.ts:325
Parameters
- camera: any
Returns Vector3

Static clearPhysicsPool

clearPhysicsPool(): void

- Defined in src/engine/math/vector3.ts:516
Returns void

Static createFromArray

createFromArray(array: number[]): Vector3

- Defined in src/engine/math/vector3.ts:129
使用一个数组创建
此操作会拷贝一份数组

static

memberof

Vector3

Parameters
- array: number[]
  
  数据源，长度必须为3，否则会抛出异常
Returns Vector3

创建出来的向量

Static createFromNumber

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

- Defined in src/engine/math/vector3.ts:113
使用数值创建
推荐使用这种方式代替new Vector3

static

memberof

Vector3

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

创建出来的向量

Static createFromTypedArray

createFromTypedArray(array: Float32Array, offset?: number): Vector3

- Defined in src/engine/math/vector3.ts:145
使用某个已有的typedArray创建
此操作不会拷贝数据，而是在原来的内存区域上操作

static

memberof

Vector3

Parameters
- array: Float32Array
  
  数据源
- offset: number = 0
Returns Vector3

Static fromPhysics

fromPhysics(v: RawVec3f): Vector3

- Defined in src/engine/math/vector3.ts:499
created by shanexyzhou
从物理引擎内的RawVec3f生成Vector3

Parameters
- v: RawVec3f
Returns Vector3

Static transformCoordinate

transformCoordinate(coordinate: DeepImmutableObject<Vector3>, transform: DeepImmutableObject<Matrix4>, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:170
Parameters
- coordinate: DeepImmutableObject<Vector3>
- transform: DeepImmutableObject<Matrix4>
- Optional dst: Vector3
Returns Vector3

Static transformQuat

transformQuat(source: DeepImmutableObject<Vector3>, rotation: DeepImmutableObject<Quaternion>, dst?: Vector3): Vector3

- Defined in src/engine/math/vector3.ts:162
使用四元数进行向量旋转

static

memberof

Vector3

Parameters
- source: DeepImmutableObject<Vector3>
  
  源向量
- rotation: DeepImmutableObject<Quaternion>
  
  用于旋转的四元数
- Optional dst: Vector3
Returns Vector3

计算结果

Generated using TypeDoc