Options
All
  • Public
  • Public/Protected
  • All
Menu

用以保存表示 (x, y, z) 向量数据的类。 Vector3 是三维图像中的主要对象,它既可以表示一个空间内的点, 也可以表示一个方向。

一个三维向量

Note: Diva 使用左手坐标系。

Hierarchy

  • Vector3

Index

Constructors

constructor

  • new Vector3(x?: number, y?: number, z?: number): Vector3
  • 根据给定的 x, y, z 坐标创建一个三位向量。

    Parameters

    • x: number = 0

      x 轴坐标

    • y: number = 0

      y 轴坐标

    • z: number = 0

      z 轴坐标

    Returns Vector3

Accessors

length

  • get length(): number
  • 获取向量长度(模)

    Returns number

tuple

  • 获取元组形式的向量数组。

    Returns Vector3Tuple

    [x:number, y:number, z:number]

x

  • get x(): number
  • set x(value: number): void
  • 获取 x 坐标

    Returns number

  • 设置 x 坐标

    Parameters

    • value: number

    Returns void

y

  • get y(): number
  • set y(value: number): void
  • 获取 y 坐标

    Returns number

  • 设置 y 坐标

    Parameters

    • value: number

    Returns void

z

  • get z(): number
  • set z(value: number): void
  • 获取 z 坐标

    Returns number

  • 设置 z 坐标

    Parameters

    • value: number

    Returns void

Methods

add

  • 获取一个新的坐标,表示当前坐标与目标坐标的向量和。

    Parameters

    • vector: Vector3

      加和向量坐标

    Returns Vector3

    新的向量

addInPlace

  • 使当前坐标加上目标坐标。

    Parameters

    • vector: Vector3

      加和向量坐标

    Returns Vector3

    当前计算更新后的向量

clone

  • 从当前向量克隆创建新向量。

    Returns Vector3

    新的向量

copyFrom

  • 从源向量复制更新当前向量。

    Parameters

    • source: Vector3Tuple

      复制源向量或者向量坐标元组

    Returns Vector3

    当前更新后的向量

  • Parameters

    Returns Vector3

crossProduct

  • 计算当前向量与另一个向量的叉乘乘积。

    Parameters

    • vector: Vector3

      计算叉乘的另一个向量。

    Returns Vector3

    两向量的叉乘乘积向量。

distanceFrom

  • distanceFrom(target: Vector3): number
  • 计算距离目标向量的距离值。

    Parameters

    Returns number

equals

  • 判断当前向量与指定向量是否严格相等。

    Parameters

    • vector: Vector3

      指定相比较的向量

    Returns boolean

    判断结果

equalsWithEpsilon

  • equalsWithEpsilon(vector: Vector3, epsilon?: number): boolean
  • 判断当前向量与指定向量是否在机械极小值(默认 0.001)误差范围内相等。

    Parameters

    • vector: Vector3

      指定相比较的向量

    • epsilon: number = ...

      机械极小值(默认 0.001)

    Returns boolean

    判断结果

lerpTo

  • 以自身为起始状态,参数传入的向量为终止状态,按指定浮点梯度进行线性插值。

    Parameters

    • end: Vector3

      终止状态的向量

    • gradient: number

      插值梯度,取值 0~1

    Returns Vector3

    新的插值向量

max

maxInPlace

min

minInPlace

normalize

  • 获取当前向量标准化的单位向量。

    Returns Vector3

    一个标准化的新向量

normalizeInPlace

  • 将当前向量标准化(归一化)。

    Returns Vector3

    当前更新后的向量

scale

  • 用一个新的坐标表示当前坐标作为原点向量进行缩放后的位置。

    Parameters

    • scale: number

      缩放比例

    Returns Vector3

    一个缩放后新的向量

scaleInPlace

  • scaleInPlace(scalar: number): Vector3
  • 将当前坐标作为原点向量进行缩放。

    Parameters

    • scalar: number

      缩放比例

    Returns Vector3

    当前更新后的向量

subtract

  • 获取一个新的坐标,表示当前坐标与目标坐标的向量差。

    Parameters

    • vector: Vector3

      做差向量坐标

    Returns Vector3

    新的向量

subtractInPlace

  • 使当前坐标减去目标坐标。

    Parameters

    • vector: Vector3

      做差向量坐标

    Returns Vector3

    当前计算更新后的向量

Static Max

  • 对给定的向量执行在各分量上做最大操作,并返回新结果向量。

    Parameters

    Returns Vector3

    最大操作结果向量

Static Min

  • 对给定的向量执行在各分量上做最小操作,并返回新结果向量。

    Parameters

    Returns Vector3

    最小操作结果向量

Static Zero

  • 创建一个各坐标为 0 的零向量。

    Returns Vector3

    创建的新向量