mxcad_3d API 文档 / Mx3dGeHyperbola
Class: Mx3dGeHyperbola 
表示一个三维空间中的双曲线对象。 该类用于创建、操作和查询双曲线的各种属性,包括其轴、位置、半径以及各种变换状态。
Hierarchy 
- ↳ - Mx3dGeHyperbola
Table of contents 
Constructors 
Methods 
- Asymptote1
- Asymptote2
- Axis
- ConjugateBranch1
- ConjugateBranch2
- Directrix1
- Directrix2
- Eccentricity
- Focal
- Focus1
- Focus2
- Location
- MajorRadius
- MinorRadius
- MirrorByAxis
- MirrorByCSYSR
- MirrorByPoint
- MirroredByAxis
- MirroredByCSYSR
- MirroredByPoint
- OtherBranch
- Parameter
- Position
- Rotate
- Rotated
- Scale
- Scaled
- SetAxis
- SetLocation
- SetMajorRadius
- SetMinorRadius
- SetPosition
- Transform
- Transformed
- TranslateBy2Points
- TranslateByVec
- TranslatedBy2Points
- TranslatedByVec
- XAxis
- YAxis
Constructors 
constructor 
• new Mx3dGeHyperbola()
默认构造函数,用于创建一个未定义的双曲线。
Overrides 
Mx3dGeObject.constructor
• new Mx3dGeHyperbola(theA2, theMajorRadius, theMinorRadius)
根据给定的主半径和次半径以及一个坐标系统(Mx3dGeCSYSR)来构造一个双曲线。 坐标系统定义了双曲线的位置,其中:
- 原点为双曲线中心,
- "X方向"定义了双曲线的主轴,
- "Y方向"定义了双曲线的次轴。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA2 | Mx3dGeCSYSR | 定义双曲线位置的坐标系统。 | 
| theMajorRadius | number | 双曲线的主半径。 | 
| theMinorRadius | number | 双曲线的次半径。 | 
Overrides 
Mx3dGeObject.constructor
Methods 
Asymptote1 
▸ Asymptote1(): Mx3dGeAxis
获取双曲线的对称轴。
Returns 
返回双曲线的对称轴。
Asymptote2 
▸ Asymptote2(): Mx3dGeAxis
获取另一条对称轴。
Returns 
返回双曲线的另一条对称轴。
Axis 
▸ Axis(): Mx3dGeAxis
获取双曲线的轴线。
Returns 
双曲线的轴线。
ConjugateBranch1 
▸ ConjugateBranch1(): Mx3dGeHyperbola
获取共轭分支1。
Returns 
双曲线的共轭分支1。
ConjugateBranch2 
▸ ConjugateBranch2(): Mx3dGeHyperbola
获取共轭分支2。
Returns 
双曲线的共轭分支2。
Directrix1 
▸ Directrix1(): Mx3dGeAxis
获取直接线1。
Returns 
双曲线的直接线1。
Directrix2 
▸ Directrix2(): Mx3dGeAxis
获取直接线2。
Returns 
双曲线的直接线2。
Eccentricity 
▸ Eccentricity(): number
获取离心率。
Returns 
number
双曲线的离心率。
Focal 
▸ Focal(): number
获取焦距。
Returns 
number
双曲线的焦距。
Focus1 
▸ Focus1(): Mx3dGePoint
获取焦点1。
Returns 
双曲线的第一个焦点。
Focus2 
▸ Focus2(): Mx3dGePoint
获取焦点2。
Returns 
双曲线的第二个焦点。
Location 
▸ Location(): Mx3dGePoint
获取双曲线的当前位置点,即中心点。
Returns 
位置点。
MajorRadius 
▸ MajorRadius(): number
获取双曲线的长轴半径。
Returns 
number
一个 number,表示双曲线的长轴半径。
MinorRadius 
▸ MinorRadius(): number
获取双曲线的短轴半径。
Returns 
number
一个 number,表示双曲线的短轴半径。
MirrorByAxis 
▸ MirrorByAxis(theA1): void
按轴镜像双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA1 | Mx3dGeAxis | 镜像轴 (Mx3dGeAxis)。 | 
Returns 
void
MirrorByCSYSR 
▸ MirrorByCSYSR(theA2): void
按坐标系镜像双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA2 | Mx3dGeCSYSR | 镜像的坐标系 (Mx3dGeCSYSR)。 | 
Returns 
void
MirrorByPoint 
▸ MirrorByPoint(theP): void
通过点镜像变换双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theP | Mx3dGePoint | 一个 Mx3dGePoint 对象,表示镜像的中心点。 | 
Returns 
void
MirroredByAxis 
▸ MirroredByAxis(theA1): Mx3dGeHyperbola
获取按轴镜像后的双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA1 | Mx3dGeAxis | 镜像轴 (Mx3dGeAxis)。 | 
Returns 
按轴镜像后的双曲线 (Mx3dGeHyperbola)。
MirroredByCSYSR 
▸ MirroredByCSYSR(theA2): Mx3dGeHyperbola
获取按坐标系镜像后的双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA2 | Mx3dGeCSYSR | 镜像的坐标系 (Mx3dGeCSYSR)。 | 
Returns 
按坐标系镜像后的双曲线 (Mx3dGeHyperbola)。
MirroredByPoint 
▸ MirroredByPoint(theP): Mx3dGeHyperbola
获取按点镜像后的双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theP | Mx3dGePoint | 镜像点 (Mx3dGePoint)。 | 
Returns 
按点镜像后的双曲线 (Mx3dGeHyperbola)。
OtherBranch 
▸ OtherBranch(): Mx3dGeHyperbola
获取双曲线的另一分支,与当前分支关于主轴对称。
Returns 
另一分支。
Parameter 
▸ Parameter(): number
获取双曲线的参数。
Returns 
number
一个 number,表示双曲线的参数。
Position 
▸ Position(): Mx3dGeCSYSR
获取双曲线的坐标系统,定义其位置和方向。
Returns 
坐标系。
Rotate 
▸ Rotate(theA1, theAng): void
旋转双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA1 | Mx3dGeAxis | 旋转轴 (Mx3dGeAxis)。 | 
| theAng | number | 旋转角度。 | 
Returns 
void
Rotated 
▸ Rotated(theA1, theAng): Mx3dGeHyperbola
获取旋转后的双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA1 | Mx3dGeAxis | 旋转轴 (Mx3dGeAxis)。 | 
| theAng | number | 旋转角度。 | 
Returns 
旋转后的双曲线 (Mx3dGeHyperbola)。
Scale 
▸ Scale(theP, theS): void
缩放双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theP | Mx3dGePoint | 缩放中心 (Mx3dGePoint)。 | 
| theS | number | 缩放比例。 | 
Returns 
void
Scaled 
▸ Scaled(theP, theS): Mx3dGeHyperbola
获取缩放后的双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theP | Mx3dGePoint | 缩放中心 (Mx3dGePoint)。 | 
| theS | number | 缩放比例。 | 
Returns 
缩放后的双曲线 (Mx3dGeHyperbola)。
SetAxis 
▸ SetAxis(theA1): void
设置双曲线的轴。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA1 | Mx3dGeAxis | 要设置的新轴。 | 
Returns 
void
SetLocation 
▸ SetLocation(theP): void
设置双曲线的位置。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theP | Mx3dGePoint | 新的位置点。 | 
Returns 
void
SetMajorRadius 
▸ SetMajorRadius(theMajorRadius): void
设置双曲线的主半径。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theMajorRadius | number | 新的主半径值。 | 
Returns 
void
SetMinorRadius 
▸ SetMinorRadius(theMinorRadius): void
设置双曲线的次半径。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theMinorRadius | number | 新的次半径值。 | 
Returns 
void
SetPosition 
▸ SetPosition(theA2): void
设置双曲线的坐标系统,从而重新定义其位置和方向。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theA2 | Mx3dGeCSYSR | 新的坐标系统。 | 
Returns 
void
Transform 
▸ Transform(theT): void
对双曲线进行变换。
Parameters 
| Name | Type | 
|---|---|
| theT | Mx3dGeTrsf | 
Returns 
void
Transformed 
▸ Transformed(theT): Mx3dGeHyperbola
获取变换后的双曲线。
Parameters 
| Name | Type | 
|---|---|
| theT | Mx3dGeTrsf | 
Returns 
变换后的双曲线 (Mx3dGeHyperbola)。
TranslateBy2Points 
▸ TranslateBy2Points(theP1, theP2): void
按点平移双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theP1 | Mx3dGePoint | 起点 (Mx3dGePoint)。 | 
| theP2 | Mx3dGePoint | 终点 (Mx3dGePoint)。 | 
Returns 
void
TranslateByVec 
▸ TranslateByVec(theV): void
按向量平移双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theV | Mx3dGeVec | 平移向量 (Mx3dGeVector)。 | 
Returns 
void
TranslatedBy2Points 
▸ TranslatedBy2Points(theP1, theP2): Mx3dGeHyperbola
获取按点平移后的双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theP1 | Mx3dGePoint | 起点 (Mx3dGePoint)。 | 
| theP2 | Mx3dGePoint | 终点 (Mx3dGePoint)。 | 
Returns 
按点平移后的双曲线 (Mx3dGeHyperbola)。
TranslatedByVec 
▸ TranslatedByVec(theV): Mx3dGeHyperbola
获取按向量平移后的双曲线。
Parameters 
| Name | Type | Description | 
|---|---|---|
| theV | Mx3dGeVec | 平移向量 (Mx3dGeVector)。 | 
Returns 
平移后的双曲线 (Mx3dGeHyperbola)。
XAxis 
▸ XAxis(): Mx3dGeAxis
获取X轴,定义双曲线的主要方向。
Returns 
X轴。
YAxis 
▸ YAxis(): Mx3dGeAxis
获取Y轴,定义双曲线的次要方向。
Returns 
Y轴。