[mxcad_3d API Document](../README. md)/Mx3dMkTorus
Class: Mx3dMkTorus
The class representing the modeling of a circular ring inherits from Mx3dMkObject
Hierarchy
↳
Mx3dMkTorus
Table of contents
Constructors
Methods
Constructors
constructor
• new Mx3dMkTorus(Axes, R1, R2)
Constructor that accepts coordinate system objects, primary and secondary radii of the torus as parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| Axes | [Mx3dGeCSYSR] (Mx3dGeCSYSR. md) | Coordinate system object |
| R1 | number | principal radius of the circular ring |
| R2 | number | sub radius of the circular ring |
Overrides
Mx3dMkObject.constructor
• new Mx3dMkTorus(Axes, R1, R2, angle)
Constructor that accepts coordinate system objects, primary and secondary radii of a torus, and an angle parameter.
Parameters
| Name | Type | Description |
|---|---|---|
| Axes | [Mx3dGeCSYSR] (Mx3dGeCSYSR. md) | Coordinate system object |
| R1 | number | principal radius of the circular ring |
| R2 | number | sub radius of the circular ring |
| Angle | number | angle parameter |
Overrides
Mx3dMkObject.constructor
• new Mx3dMkTorus(Axes, R1, R2, angle1, angle2)
Constructor, accepting coordinate system objects, primary radius, secondary radius, and two angle parameters of the torus.
Parameters
| Name | Type | Description |
|---|---|---|
| Axes | [Mx3dGeCSYSR] (Mx3dGeCSYSR. md) | Coordinate system object |
| R1 | number | principal radius of the circular ring |
| R2 | number | sub radius of the circular ring |
| Angle1 | Number | The first angle parameter |
| Angle2 | Number | Second angle parameter |
Overrides
Mx3dMkObject.constructor
• new Mx3dMkTorus(Axes, R1, R2, angle1, angle2, angle)
Constructor that accepts coordinate system objects, primary radius, secondary radius, and three angle parameters for a torus.
Parameters
| Name | Type | Description |
|---|---|---|
| Axes | [Mx3dGeCSYSR] (Mx3dGeCSYSR. md) | Coordinate system object |
| R1 | number | principal radius of the circular ring |
| R2 | number | sub radius of the circular ring |
| Angle1 | Number | The first angle parameter |
| Angle2 | Number | Second angle parameter |
angle | number | - |
Overrides
Mx3dMkObject.constructor
Methods
Build
▸ Build(): void
Execute modeling algorithms for circular bodies.
Returns
void
Face
▸ Face(): Mx3dShapeFace
Obtain the topological surface shape of the torus.
Returns
Tuopu surface shape.
IsDone
▸ IsDone(): boolean
Check if the modeling algorithm has been executed successfully.
Returns
boolean
The flag indicating whether the modeling algorithm execution has been completed, with true indicating completion and false indicating failure.
Shape
▸ Shape(): Mx3dShapeObject
Obtain the topological shape of the torus.
Returns
Topological shape.
Shell
▸ Shell(): Mx3dShapeShell
Obtain the topological shell shape of the torus.
Returns
Topological shell shape.
Solid
▸ Solid(): Mx3dShapeSolid
Obtain the topological solid shape of the torus.
Returns
Topological entity shape.