xr-frame / Exports / Vector4

# Class: Vector4

# Table of contents

# Constructors

constructor

# Properties

ONE
ZERO

# Accessors

# Methods

# Constructors

# constructor

• new Vector4(raw?, offset?)

# Parameters

Name	Type
`raw?`	`Float32Array`
`offset?`	`number`

# Properties

# ONE

▪ Static Readonly ONE: Vector4

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

readonly

static

memberof Vector3

# ZERO

▪ Static Readonly ZERO: Vector4

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

static

readonly

memberof Vector4

# Accessors

# w

• get w(): number

w值

memberof Vector4

# Returns

number

• set w(val): void

w值

# Parameters

Name	Type
`val`	`number`

# Returns

void

# x

• get x(): number

x值

memberof Vector4

# Returns

number

• set x(val): void

x值

# Parameters

Name	Type
`val`	`number`

# Returns

void

# y

• get y(): number

y值

memberof Vector4

# Returns

number

• set y(val): void

y值

# Parameters

Name	Type
`val`	`number`

# Returns

void

# z

• get z(): number

z值

memberof Vector4

# Returns

number

• set z(val): void

z值

# Parameters

Name	Type
`val`	`number`

# Returns

void

# Methods

# add

▸ add(v, dst?): Vector4

向量加法

memberof Vector4

# Parameters

Name	Type	Description
`v`	`Vector4`	目标向量
`dst?`	`Vector4`	-

# Returns

Vector4

计算结果

# clone

▸ clone(): Vector4

拷贝该向量

memberof Vector4

# Returns

Vector4

拷贝出来的对象

# dot

▸ dot(v): number

向量点乘

memberof Vector4

# Parameters

Name	Type	Description
`v`	`Vector4`	目标向量

# Returns

number

计算结果

# equal

▸ equal(v): boolean

判断与目标向量的值是否相等

memberof Vector4

# Parameters

Name	Type	Description
`v`	`Vector4`	目标向量

# Returns

boolean

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

# isZero

▸ isZero(): boolean

是否为零向量

memberof Vector4

# Returns

boolean

# lerp

▸ lerp(v, f, dst?): Vector4

在该向量与目标向量之间计算插值

memberof Vector4

# Parameters

Name	Type	Description
`v`	`Vector4`	目标向量
`f`	`number`	插值系数
`dst?`	`Vector4`	-

# Returns

Vector4

计算结果

# negate

▸ negate(): Vector4

取反

# Returns

Vector4

# scale

▸ scale(f, dst?): Vector4

向量缩放

memberof Vector4

# Parameters

Name	Type	Description
`f`	`number`	缩放比
`dst?`	`Vector4`	-

# Returns

Vector4

计算结果

# set

▸ set(v): Vector4

拷贝目标向量的值到该向量

memberof Vector4

# Parameters

Name	Type
`v`	`Vector4`

# Returns

Vector4

自身

# setArray

▸ setArray(value, offset?): Vector4

# Parameters

Name	Type
`value`	`ArrayLike`<`number`>
`offset?`	`number`

# Returns

Vector4

# setValue

▸ setValue(x, y, z, w): Vector4

设置向量的值

memberof Vector4

# Parameters

Name	Type	Description
`x`	`number`	x值
`y`	`number`	y值
`z`	`number`	z值
`w`	`number`	w值

# Returns

Vector4

自身

# sub

▸ sub(v, dst?): Vector4

向量减法

memberof Vector4

# Parameters

Name	Type	Description
`v`	`Vector4`	目标向量
`dst?`	`Vector4`	-

# Returns

Vector4

计算结果

# toArray

▸ toArray(): number[]

返回向量数据

memberof Vector4

# Returns

number[]

矩阵数据，以JSArray返回

# createFromArray

▸ Static createFromArray(array): Vector4

使用一个数组创建此操作会拷贝一份数组

static

memberof Vector4

# Parameters

Name	Type	Description
`array`	`number`[]	数据源，长度必须为4，否则会抛出异常

# Returns

Vector4

创建出来的向量

# createFromNumber

▸ Static createFromNumber(x, y, z, w): Vector4

使用数值创建推荐使用这种方式代替new Vector4

static

memberof Vector4

# Parameters

Name	Type
`x`	`number`
`y`	`number`
`z`	`number`
`w`	`number`

# Returns

Vector4

创建出来的向量

# createFromTypedArray

▸ Static createFromTypedArray(array, offset?): Vector4

使用某个已有的typedArray创建此操作不会拷贝数据，而是在原来的内存区域上操作

static

memberof Vector4

# Parameters

Name	Type	Default value	Description
`array`	`Float32Array`	`undefined`	数据源
`offset`	`number`	`0`	-

# Returns

Vector4