mxcad_3d API 文档 / Mx3dGeVec
Class: Mx3dGeVec 
表示一个三维向量的类。用于三维几何运算。
Hierarchy 
- ↳ - Mx3dGeVec
Table of contents 
Constructors 
Methods 
- Add
- Added
- Angle
- AngleWithRef
- Cross
- CrossCross
- CrossCrossed
- CrossMagnitude
- CrossSquareMagnitude
- Crossed
- Divide
- Divided
- Dot
- DotCross
- IsEqual
- IsNormal
- IsOpposite
- IsParallel
- Magnitude
- MirrorByAxis
- MirrorByCSYSR
- MirrorByVec
- MirroredByAxis
- MirroredByCSYSR
- MirroredByVec
- Multiplied
- Multiply
- Normalize
- Normalized
- Reverse
- Reversed
- Rotate
- Rotated
- Scale
- Scaled
- SetLinearForm
- SetX
- SetXYZ
- SetY
- SetZ
- SquareMagnitude
- Subtract
- Subtracted
- Transform
- Transformed
- X
- Y
- Z
Constructors 
constructor 
• new Mx3dGeVec()
构造一个新的 Mx3dGeVec 实例。 可以不带参数,或者带三个数值参数,或者带两个点。
Overrides 
Mx3dGeObject.constructor
• new Mx3dGeVec(x, y, z)
Parameters 
| Name | Type | 
|---|---|
| x | number | 
| y | number | 
| z | number | 
Overrides 
Mx3dGeObject.constructor
• new Mx3dGeVec(thePoint1, thePoint2)
Parameters 
| Name | Type | 
|---|---|
| thePoint1 | Mx3dGePoint | 
| thePoint2 | Mx3dGePoint | 
Overrides 
Mx3dGeObject.constructor
Methods 
Add 
▸ Add(other): void
将当前向量与另一个向量相加。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
Returns 
void
Added 
▸ Added(other): Mx3dGeVec
返回当前向量与另一个向量相加的结果。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
Returns 
相加后的向量。
Angle 
▸ Angle(other): number
计算两个向量之间的角度。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
Returns 
number
角度值。
AngleWithRef 
▸ AngleWithRef(other, ref): number
计算两个向量之间的带参考向量的角度。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
| ref | Mx3dGeVec | 参考向量。 | 
Returns 
number
带参考向量的角度值。
Cross 
▸ Cross(right): void
计算两个向量的叉积。
Parameters 
| Name | Type | Description | 
|---|---|---|
| right | Mx3dGeVec | 另一个向量。 | 
Returns 
void
CrossCross 
▸ CrossCross(v1, v2): void
计算三个向量的叉积。
Parameters 
| Name | Type | Description | 
|---|---|---|
| v1 | Mx3dGeVec | 向量1。 | 
| v2 | Mx3dGeVec | 向量2。 | 
Returns 
void
CrossCrossed 
▸ CrossCrossed(v1, v2): Mx3dGeVec
返回三个向量的叉积结果。
Parameters 
| Name | Type | Description | 
|---|---|---|
| v1 | Mx3dGeVec | 向量1。 | 
| v2 | Mx3dGeVec | 向量2。 | 
Returns 
叉积后的向量。
CrossMagnitude 
▸ CrossMagnitude(right): number
计算两个向量的叉积的模。
Parameters 
| Name | Type | Description | 
|---|---|---|
| right | Mx3dGeVec | 另一个向量。 | 
Returns 
number
叉积的模。
CrossSquareMagnitude 
▸ CrossSquareMagnitude(right): number
计算两个向量的叉积模的平方。
Parameters 
| Name | Type | Description | 
|---|---|---|
| right | Mx3dGeVec | 另一个向量。 | 
Returns 
number
叉积模的平方。
Crossed 
▸ Crossed(right): Mx3dGeVec
返回两个向量的叉积结果。
Parameters 
| Name | Type | Description | 
|---|---|---|
| right | Mx3dGeVec | 另一个向量。 | 
Returns 
叉积后的向量。
Divide 
▸ Divide(scalar): void
将当前向量除以一个标量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| scalar | number | 标量值。 | 
Returns 
void
Divided 
▸ Divided(scalar): Mx3dGeVec
返回当前向量除以标量的结果。
Parameters 
| Name | Type | Description | 
|---|---|---|
| scalar | number | 标量值。 | 
Returns 
除以标量后的向量。
Dot 
▸ Dot(other): number
计算两个向量的点积。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
Returns 
number
点积值。
DotCross 
▸ DotCross(v1, v2): number
计算三个向量的点-叉积。
Parameters 
| Name | Type | Description | 
|---|---|---|
| v1 | Mx3dGeVec | 向量1。 | 
| v2 | Mx3dGeVec | 向量2。 | 
Returns 
number
点-叉积值。
IsEqual 
▸ IsEqual(other, linearTolerance, angularTolerance): boolean
判断两个向量是否相等。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
| linearTolerance | number | 线性公差。 | 
| angularTolerance | number | 角度公差。 | 
Returns 
boolean
是否相等。
IsNormal 
▸ IsNormal(other, angularTolerance): boolean
判断两个向量是否互为法向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
| angularTolerance | number | 角度公差。 | 
Returns 
boolean
是否互为法向量。
IsOpposite 
▸ IsOpposite(other, angularTolerance): boolean
判断两个向量是否互为反向。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
| angularTolerance | number | 角度公差。 | 
Returns 
boolean
是否互为反向。
IsParallel 
▸ IsParallel(other, angularTolerance): boolean
判断两个向量是否平行。
Parameters 
| Name | Type | Description | 
|---|---|---|
| other | Mx3dGeVec | 另一个向量。 | 
| angularTolerance | number | 角度公差。 | 
Returns 
boolean
是否平行。
Magnitude 
▸ Magnitude(): number
获取向量的模。
Returns 
number
向量的模。
MirrorByAxis 
▸ MirrorByAxis(axis): void
根据一个轴镜像当前向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| axis | Mx3dGeAxis | 镜像轴。 | 
Returns 
void
MirrorByCSYSR 
▸ MirrorByCSYSR(csysr): void
根据一个坐标系镜像当前向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| csysr | Mx3dGeCSYSR | 坐标系。 | 
Returns 
void
MirrorByVec 
▸ MirrorByVec(vec): void
根据一个向量镜像当前向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| vec | Mx3dGeVec | 镜像向量。 | 
Returns 
void
MirroredByAxis 
▸ MirroredByAxis(axis): Mx3dGeVec
返回根据一个轴镜像后的向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| axis | Mx3dGeAxis | 镜像轴。 | 
Returns 
镜像后的向量。
MirroredByCSYSR 
▸ MirroredByCSYSR(csysr): Mx3dGeVec
返回根据一个坐标系镜像后的向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| csysr | Mx3dGeCSYSR | 坐标系。 | 
Returns 
镜像后的向量。
MirroredByVec 
▸ MirroredByVec(vec): Mx3dGeVec
返回根据一个向量镜像后的向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| vec | Mx3dGeVec | 镜像向量。 | 
Returns 
镜像后的向量。
Multiplied 
▸ Multiplied(scalar): Mx3dGeVec
返回当前向量乘以标量的结果。
Parameters 
| Name | Type | Description | 
|---|---|---|
| scalar | number | 标量值。 | 
Returns 
乘以标量后的向量。
Multiply 
▸ Multiply(scalar): void
将当前向量乘以一个标量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| scalar | number | 标量值。 | 
Returns 
void
Normalize 
▸ Normalize(): void
将当前向量归一化。
Returns 
void
Normalized 
▸ Normalized(): Mx3dGeVec
返回归一化后的向量。
Returns 
归一化后的向量。
Reverse 
▸ Reverse(): void
反转当前向量的方向。
Returns 
void
Reversed 
▸ Reversed(): Mx3dGeVec
返回反转后的向量。
Returns 
反转后的向量。
Rotate 
▸ Rotate(axis, ang): void
旋转当前向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| axis | Mx3dGeAxis | 旋转轴。 | 
| ang | number | 旋转角度。 | 
Returns 
void
Rotated 
▸ Rotated(axis, ang): Mx3dGeVec
返回旋转后的向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| axis | Mx3dGeAxis | 旋转轴。 | 
| ang | number | 旋转角度。 | 
Returns 
旋转后的向量。
Scale 
▸ Scale(s): void
缩放当前向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| s | number | 缩放系数。 | 
Returns 
void
Scaled 
▸ Scaled(s): Mx3dGeVec
返回缩放后的向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| s | number | 缩放系数。 | 
Returns 
缩放后的向量。
SetLinearForm 
▸ SetLinearForm(v1, v2): void
设置当前向量为线性组合。
Parameters 
| Name | Type | Description | 
|---|---|---|
| v1 | Mx3dGeVec | 向量1。 | 
| v2 | Mx3dGeVec | 向量2。 | 
Returns 
void
▸ SetLinearForm(a1, v1, v2): void
Parameters 
| Name | Type | 
|---|---|
| a1 | number | 
| v1 | Mx3dGeVec | 
| v2 | Mx3dGeVec | 
Returns 
void
▸ SetLinearForm(a1, v1, a2, v2): void
Parameters 
| Name | Type | 
|---|---|
| a1 | number | 
| v1 | Mx3dGeVec | 
| a2 | number | 
| v2 | Mx3dGeVec | 
Returns 
void
▸ SetLinearForm(a1, v1, a2, v2, v3): void
Parameters 
| Name | Type | 
|---|---|
| a1 | number | 
| v1 | Mx3dGeVec | 
| a2 | number | 
| v2 | Mx3dGeVec | 
| v3 | Mx3dGeVec | 
Returns 
void
▸ SetLinearForm(a1, v1, a2, v2, a3, v3): void
Parameters 
| Name | Type | 
|---|---|
| a1 | number | 
| v1 | Mx3dGeVec | 
| a2 | number | 
| v2 | Mx3dGeVec | 
| a3 | number | 
| v3 | Mx3dGeVec | 
Returns 
void
▸ SetLinearForm(a1, v1, a2, v2, a3, v3, v4): void
Parameters 
| Name | Type | 
|---|---|
| a1 | number | 
| v1 | Mx3dGeVec | 
| a2 | number | 
| v2 | Mx3dGeVec | 
| a3 | number | 
| v3 | Mx3dGeVec | 
| v4 | Mx3dGeVec | 
Returns 
void
SetX 
▸ SetX(x): void
设置向量的 x 分量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| x | number | 新的 x 分量。 | 
Returns 
void
SetXYZ 
▸ SetXYZ(x, y, z): void
设置向量的 x, y 和 z 分量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| x | number | 新的 x 分量。 | 
| y | number | 新的 y 分量。 | 
| z | number | 新的 z 分量。 | 
Returns 
void
SetY 
▸ SetY(y): void
设置向量的 y 分量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| y | number | 新的 y 分量。 | 
Returns 
void
SetZ 
▸ SetZ(z): void
设置向量的 z 分量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| z | number | 新的 z 分量。 | 
Returns 
void
SquareMagnitude 
▸ SquareMagnitude(): number
获取向量模的平方。
Returns 
number
向量模的平方。
Subtract 
▸ Subtract(right): void
从当前向量中减去另一个向量。
Parameters 
| Name | Type | Description | 
|---|---|---|
| right | Mx3dGeVec | 另一个向量。 | 
Returns 
void
Subtracted 
▸ Subtracted(right): Mx3dGeVec
返回当前向量减去另一个向量的结果。
Parameters 
| Name | Type | Description | 
|---|---|---|
| right | Mx3dGeVec | 另一个向量。 | 
Returns 
相减后的向量。
Transform 
▸ Transform(t): void
根据坐标系变换当前向量。
Parameters 
| Name | Type | 
|---|---|
| t | Mx3dGeTrsf | 
Returns 
void
Transformed 
▸ Transformed(t): Mx3dGeVec
返回根据坐标系变换后的向量。
Parameters 
| Name | Type | 
|---|---|
| t | Mx3dGeTrsf | 
Returns 
变换后的向量。
X 
▸ X(): number
获取向量的 x 分量。
Returns 
number
x 分量。
Y 
▸ Y(): number
获取向量的 y 分量。
Returns 
number
y 分量。
Z 
▸ Z(): number
获取向量的 z 分量。
Returns 
number
z 分量。