M3D / M3D / M3DMath / Quaternion

Class: Quaternion

M3D.M3DMath.Quaternion

Memberof

M3D.M3DMath

Description

四元数

Date

2022-1-12

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Table of contents

Constructors

• constructor

Properties

• w
• x
• y
• z
• _IDENTITY

Methods

• Add
• AddED
• Clone
• Conjugate
• ConjugateED
• Data
• DotProduct
• Equal
• Equals
• EulerAngles
• FromAngleAxis
• FromAxes
• FromEulerAngles
• FromLookRotation
• FromRotationMatrix
• FromRotationTo
• GetAixsValue
• GetAngleValue
• GetValue
• Inverse
• InverseED
• IsZero
• LengthSquared
• Multiply
• MultiplyED
• Nlerp
• NlerpED
• Normalize
• NormalizeED
• Normalized
• NormalizedED
• PitchAngle
• RollAngle
• RotationMatrix
• Slerp
• SlerpED
• Sub
• SubED
• ToMatrix
• ToZero
• Tostring
• YawAngle
• copyFrom
• IDENTITY
• MatrixToQuaternion
• Qexp
• Qlerp
• Qlog
• QslerpNoInvert
• QslerpNoInvertExtraSpins
• Qspline
• Qsquad

Constructors

constructor

• new Quaternion(): Quaternion

Returns

Quaternion

Description

构造函数

• new Quaternion(vector): Quaternion

Parameters

Name	Type
vector	Quaternion

Returns

Quaternion

Description

构造函数

• new Quaternion(matrix): Quaternion

Parameters

Name	Type
matrix	Matrix3

Returns

Quaternion

Description

构造函数

• new Quaternion(angle): Quaternion

Parameters

Name	Type
angle	number

Returns

Quaternion

Description

构造函数

• new Quaternion(data): Quaternion

Parameters

Name	Type
data	Float32Array

Returns

Quaternion

Description

构造函数

• new Quaternion(angle, axis): Quaternion

Parameters

Name	Type
angle	number
axis	Vector3

Returns

Quaternion

Description

构造函数

• new Quaternion(start, end): Quaternion

Parameters

Name	Type
start	Vector3
end	Vector3

Returns

Quaternion

Description

构造函数

• new Quaternion(x, y, z): Quaternion

Parameters

Name	Type
x	number
y	number
z	number

Returns

Quaternion

Description

构造函数

• new Quaternion(xAxis, yAxis, zAxis): Quaternion

Parameters

Name	Type
xAxis	Vector3
yAxis	Vector3
zAxis	Vector3

Returns

Quaternion

Description

构造函数

• new Quaternion(w, x, y, z): Quaternion

Parameters

Name	Type
w	number
x	number
y	number
z	number

Returns

Quaternion

Description

构造函数

Properties

w

• w: number

---

x

• x: number

---

y

• y: number

---

z

• z: number

---

_IDENTITY

▪ Static _IDENTITY: Quaternion

Methods

Add

▸ Add(rhs): Quaternion

Parameters

Name	Type
rhs	Quaternion

Returns

Quaternion

---

AddED

▸ AddED(rhs): Quaternion

Parameters

Name	Type
rhs	Quaternion

Returns

Quaternion

---

Clone

▸ Clone(): Quaternion

Returns

Quaternion

---

Conjugate

▸ Conjugate(): Quaternion

Returns

Quaternion

---

ConjugateED

▸ ConjugateED(): Quaternion

Returns

Quaternion

---

Data

▸ Data(): Float32Array

Returns

Float32Array

Description

获取四元数数据

---

DotProduct

▸ DotProduct(rhs): number

Parameters

Name	Type
rhs	Quaternion

Returns

number

---

Equal

▸ Equal(v, tolerance): boolean

Parameters

Name	Type
v	Quaternion
tolerance	number

Returns

boolean

---

Equals

▸ Equals(rhs): Boolean

Parameters

Name	Type
rhs	Quaternion

Returns

Boolean

---

EulerAngles

▸ EulerAngles(): Vector3

Returns

Vector3

---

FromAngleAxis

▸ FromAngleAxis(angle, axis): void

Parameters

Name	Type
angle	number
axis	Vector3

Returns

void

---

FromAxes

▸ FromAxes(xAxis, yAxis, zAxis): void

Parameters

Name	Type
xAxis	Vector3
yAxis	Vector3
zAxis	Vector3

Returns

void

---

FromEulerAngles

▸ FromEulerAngles(x, y, z): void

Parameters

Name	Type
x	number
y	number
z	number

Returns

void

---

FromLookRotation

▸ FromLookRotation(direction, upDirection): boolean

Parameters

Name	Type
direction	Vector3
upDirection	Vector3

Returns

boolean

---

FromRotationMatrix

▸ FromRotationMatrix(matrix): void

Parameters

Name	Type
matrix	Matrix3

Returns

void

---

FromRotationTo

▸ FromRotationTo(start, end): void

Parameters

Name	Type
start	Vector3
end	Vector3

Returns

void

---

GetAixsValue

▸ GetAixsValue(): Vector3

Returns

Vector3

Description

获取轴向

---

GetAngleValue

▸ GetAngleValue(): number

Returns

number

Description

获取角度值

---

GetValue

▸ GetValue(axis): any[]

Parameters

Name	Type
axis	Vector3

Returns

any[]

Description

获取角度及轴向

---

Inverse

▸ Inverse(): Quaternion

Returns

Quaternion

---

InverseED

▸ InverseED(): Quaternion

Returns

Quaternion

---

IsZero

▸ IsZero(): boolean

Returns

boolean

Description

判断四元数值是否为0

---

LengthSquared

▸ LengthSquared(): number

Returns

number

---

Multiply

▸ Multiply(x): Quaternion

Parameters

Name	Type
x	number

Returns

Quaternion

▸ Multiply(x): Vector3

Parameters

Name	Type
x	Vector3

Returns

Vector3

▸ Multiply(x): Quaternion

Parameters

Name	Type
x	Quaternion

Returns

Quaternion

---

MultiplyED

▸ MultiplyED(rhs): Quaternion

Parameters

Name	Type
rhs	number

Returns

Quaternion

▸ MultiplyED(x): Quaternion

Parameters

Name	Type
x	Quaternion

Returns

Quaternion

---

Nlerp

▸ Nlerp(rhs, t, shortestPath): Quaternion

Parameters

Name	Type
rhs	Quaternion
t	number
shortestPath	boolean

Returns

Quaternion

---

NlerpED

▸ NlerpED(rhs, t, shortestPath): Quaternion

Parameters

Name	Type
rhs	Quaternion
t	number
shortestPath	boolean

Returns

Quaternion

---

Normalize

▸ Normalize(): void

Returns

void

---

NormalizeED

▸ NormalizeED(): Quaternion

Returns

Quaternion

---

Normalized

▸ Normalized(): Quaternion

Returns

Quaternion

---

NormalizedED

▸ NormalizedED(): Quaternion

Returns

Quaternion

---

PitchAngle

▸ PitchAngle(): number

Returns

number

---

RollAngle

▸ RollAngle(): number

Returns

number

---

RotationMatrix

▸ RotationMatrix(): Matrix3

Returns

Matrix3

---

Slerp

▸ Slerp(rhs, t): Quaternion

Parameters

Name	Type
rhs	Quaternion
t	number

Returns

Quaternion

---

SlerpED

▸ SlerpED(rhs, t): Quaternion

Parameters

Name	Type
rhs	Quaternion
t	number

Returns

Quaternion

---

Sub

▸ Sub(rhs): Quaternion

Parameters

Name	Type
rhs	Quaternion

Returns

Quaternion

---

SubED

▸ SubED(rhs): Quaternion

Parameters

Name	Type
rhs	Quaternion

Returns

Quaternion

---

ToMatrix

▸ ToMatrix(matrix): void

Parameters

Name	Type
matrix	number[][]

Returns

void

---

ToZero

▸ ToZero(): void

Returns

void

---

Tostring

▸ Tostring(): string

Returns

string

Description

四元数数据转字符串信息

---

YawAngle

▸ YawAngle(): number

Returns

number

---

copyFrom

▸ copyFrom(rhs): void

Parameters

Name	Type
rhs	Quaternion

Returns

void

---

IDENTITY

▸ IDENTITY(): Quaternion

Returns

Quaternion

Description

获取单位四元数

---

MatrixToQuaternion

▸ MatrixToQuaternion(matrix): Quaternion

Parameters

Name	Type
matrix	number[][]

Returns

Quaternion

Description

矩阵转四元数

---

Qexp

▸ Qexp(q): Quaternion

Parameters

Name	Type
q	Quaternion

Returns

Quaternion

---

Qlerp

▸ Qlerp(q1, q2, t): Quaternion

Parameters

Name	Type
q1	Quaternion
q2	Quaternion
t	number

Returns

Quaternion

---

Qlog

▸ Qlog(q): Quaternion

Parameters

Name	Type
q	Quaternion

Returns

Quaternion

---

QslerpNoInvert

▸ QslerpNoInvert(q1, q2, t): Quaternion

Parameters

Name	Type
q1	Quaternion
q2	Quaternion
t	number

Returns

Quaternion

---

QslerpNoInvertExtraSpins

▸ QslerpNoInvertExtraSpins(rkP, rkQ, fT, iExtraSpins): Quaternion

Parameters

Name	Type
rkP	Quaternion
rkQ	Quaternion
fT	number
iExtraSpins	number

Returns

Quaternion

---

Qspline

▸ Qspline(qnm1, qn, qnp1): Quaternion

Parameters

Name	Type
qnm1	Quaternion
qn	Quaternion
qnp1	Quaternion

Returns

Quaternion

---

Qsquad

▸ Qsquad(q1, q2, a, b, t): Quaternion

Parameters

Name	Type
q1	Quaternion
q2	Quaternion
a	Quaternion
b	Quaternion
t	number

Returns

Quaternion