[mxcad_3d API Document](../README. md)/Mx3dGeomSphericalSurface
Class: Mx3dGeomSphericalSurface
Representing a sphere in three-dimensional space. This type encapsulates the functionality of manipulating spherical properties and methods.
Hierarchy
↳
Mx3dGeomSphericalSurface
Table of contents
Constructors
Methods
- Area
- Axis
- Bounds
- Coefficients
- Continuity
- Copy
- D0
- D1
- D2
- D3
- DN
- DynamicType
- Face
- IsCNu
- IsCNv
- IsUClosed
- IsUPeriodic
- IsVClosed
- IsVPeriodic
- Location
- MirrorByAxis
- MirrorByCSYSR
- MirrorByPoint
- MirroredByAxis
- MirroredByCSYSR
- MirroredByPoint
- Position
- Radius
- Rotate
- Rotated
- Scale
- Scaled
- SetAxis
- SetLocation
- SetPosition
- SetRadius
- Transform
- TransformParameters
- Transformed
- TranslateBy2Points
- TranslateByVec
- TranslatedBy2Points
- TranslatedByVec
- UPeriod
- UReverse
- UReversed
- UReversedParameter
- VPeriod
- VReverse
- VReversed
- VReversedParameter
- Value
- Volume
- DownCast
Constructors
constructor
• new Mx3dGeomSphericalSurface(A3, Radius)
Construct a sphere with a given coordinate system and radius.
Parameters
| Name | Type | Description |
|---|---|---|
| A3 | Mx3dGeCSYSR (Mx3dGeCSYSR. md) | Surface Local Coordinate System (Mx3dGeCSYSR) |
| Radius | number | The radius of a sphere |
Overrides
Mx3dGeomElementarySurface.constructor
Methods
Area
▸ Area(): number
Calculate the spherical area.
Returns
number
Surface area.
Axis
▸ Axis(): Mx3dGeAxis
Obtain the main axis (Z-axis) of the surface.
Returns
Definition of the main axis on the surface.
Inherited from
Mx3dGeomElementarySurface.Axis
Bounds
▸ Bounds(U1U2V1V2): void
Retrieve the boundary of the parameter field.
Parameters
| Name | Type | Description |
|---|---|---|
| U1U2V1V2 | [dU1: number, dU2: number, dV1: number, dV2: number] | Array containing boundaries: [dU1, dU2, dV1, dV2]。 |
Returns
void
Coefficients
▸ Coefficients(A1A2A3B1B2B3C1C2C3D): void
Set the coefficients of the spherical implicit equation.
Parameters
| Name | Type | Description |
|---|---|---|
| A1A2A3B1B2B3C1C2C3D | [A1: number, A2: number, A3: number, B1: number, B2: number, B3: number, C1: number, C2: number, C3: number, D: number] | Coefficient array: [A1, A2, A3, B1, B2, B3, C1, C2, C3, D]。 |
Returns
void
Continuity
▸ Continuity(): MxGAShapeEnum
Return the global continuity of the surface (MxGAShapeenum).
Returns
The continuity of the surface on a global scale.
Inherited from
Mx3dGeomElementarySurface.Continuity
Copy
▸ Copy(): Mx3dGeomObject
Create a copy of the sphere.
Returns
A new instance of a sphere.
D0
▸ D0(U, V, P): void
Calculate the surface points for the given U and V parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| The 'U' | 'number' | U parameter |
| V | number | V parameter |
| P | [Mx3dGePoint] (Mx3dGePoint. md) | Points on the surface |
Returns
void
D1
▸ D1(U, V, P, D1U, D1V): void
Calculate the point and its first derivative for the given U and V parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| The 'U' | 'number' | U parameter |
| V | number | V parameter |
| P | [Mx3dGePoint] (Mx3dGePoint. md) | Points on the surface |
| D1U | [Mx3dGeVec] (Mx3dGeVec. md) | Derivative in the U direction |
| D1V | [Mx3dGeVec] (Mx3dGeVec. md) | Derivative in the V direction |
Returns
void
D2
▸ D2(U, V, P, D1U, D1V, D2U, D2V, D2UV): void
Calculate the point, first and second derivatives of the given U and V parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| The 'U' | 'number' | U parameter |
| V | number | V parameter |
| P | [Mx3dGePoint] (Mx3dGePoint. md) | Points on the surface |
| D1U | [Mx3dGeVec] (Mx3dGeVec. md) | First derivative in the U direction |
| D1V | [Mx3dGeVec] (Mx3dGeVec. md) | First derivative in the V direction |
| D2U | [Mx3dGeVec] (Mx3dGeVec. md) | Second derivative in the U direction |
| D2V | [Mx3dGeVec] (Mx3dGeVec. md) | Second derivative in the V direction |
| D2UV | [Mx3dGeVec] (Mx3dGeVec. md) | Second order mixed derivative |
Returns
void
D3
▸ D3(U, V, P, D1U, D1V, D2U, D2V, D2UV, D3U, D3V, D3UUV, D3UVV): void
Calculate the point, first, second, and third derivatives of the given U and V parameters.
Parameters
| Name | Type | Description |
|---|---|---|
| The 'U' | 'number' | U parameter |
| V | number | V parameter |
| P | [Mx3dGePoint] (Mx3dGePoint. md) | Points on the surface |
| D1U | [Mx3dGeVec] (Mx3dGeVec. md) | First derivative in the U direction |
| D1V | [Mx3dGeVec] (Mx3dGeVec. md) | First derivative in the V direction |
| D2U | [Mx3dGeVec] (Mx3dGeVec. md) | Second derivative in the U direction |
| D2V | [Mx3dGeVec] (Mx3dGeVec. md) | Second derivative in the V direction |
| D2UV | [Mx3dGeVec] (Mx3dGeVec. md) | Second order mixed derivative |
| D3U | [Mx3dGeVec] (Mx3dGeVec. md) | Third derivative in the U direction |
| D3V | [Mx3dGeVec] (Mx3dGeVec. md) | Third derivative in the V direction |
| D3UUV | [Mx3dGeVec] (Mx3dGeVec. md) | Third order mixed derivatives (U and U) |
| D3UVV | [Mx3dGeVec] (Mx3dGeVec. md) | Third order mixed derivative (U and V) |
Returns
void
DN
▸ DN(U, V, Nu, Nv): Mx3dGeVec
Calculate the specified order derivative in the U and V directions.
Parameters
| Name | Type | Description |
|---|---|---|
| The 'U' | 'number' | U parameter |
| V | number | V parameter |
| Nu | number | derivative order in the U direction |
| Nv | number | derivative order in the V direction |
Returns
Nth derivative vector.
DynamicType
▸ DynamicType(): string
Return the dynamic type of the object.
Returns
string
A dynamically typed string.
Overrides
Mx3dGeomElementarySurface.DynamicType
Face
▸ Face(TolDegen): Mx3dShapeFace
Generate surfaces using degraded tolerance.
Parameters
| Name | Type | Description |
|---|---|---|
| TolDegen | number | Degradation tolerance |
Returns
Surface representation of the surface.
▸ Face(W, Inside): Mx3dShapeFace
Generate surface faces using wireframes and internal markers.
Parameters
| Name | Type | Description |
|---|---|---|
| W | [Mx3dShapeWire] (Mx3dShapeWire. md) | Define the wireframe of the boundary |
| Inside | boolean | Boolean value, indicating whether the face is within the wireframe |
Returns
Surface representation of the surface.
▸ Face(UMin, UMax, VMin, VMax, TolDegen): Mx3dShapeFace
Generate surfaces with specified parameter ranges and degradation tolerances.
Parameters
| Name | Type | Description |
|---|---|---|
| UMin | number | The minimum U value of the parameter range |
| UMax | number | The maximum U value within the parameter range |
| VMin | number | The minimum V value of the parameter range |
| VMax | number | The maximum V value within the parameter range |
| TolDegen | number | Degradation tolerance, used to handle geometric degradation situations |
Returns
A surface representation is usually a closed surface segment.
IsCNu
▸ IsCNu(N): boolean
Check if the continuity of the surface in the U parameter direction meets the specified level.
Parameters
| Name | Type | Description |
|---|---|---|
| N | number | The continuity level to be checked |
Returns
boolean
If the continuity level meets the condition, return true; Otherwise, return false.
Inherited from
Mx3dGeomElementarySurface.IsCNu
IsCNv
▸ IsCNv(N): boolean
Check if the continuity of the surface in the V-parameter direction meets the specified level.
Parameters
| Name | Type | Description |
|---|---|---|
| N | number | The continuity level to be checked |
Returns
boolean
If the continuity level meets the condition, return true; Otherwise, return false.
Inherited from
Mx3dGeomElementarySurface.IsCNv
IsUClosed
▸ IsUClosed(): boolean
Check if the surface is closed in the U direction.
Returns
boolean
If the U direction is closed, it is True; otherwise, it is False.
IsUPeriodic
▸ IsUPeriodic(): boolean
Check if the surface is periodic in the U direction.
Returns
boolean
If the U direction is periodic, it is True; otherwise, it is False.
IsVClosed
▸ IsVClosed(): boolean
Check if the surface is closed in the V direction.
Returns
boolean
If the V direction is closed, it is True; otherwise, it is False.
IsVPeriodic
▸ IsVPeriodic(): boolean
Check if the surface is periodic in the V direction.
Returns
boolean
If the V direction is periodic, it is True; otherwise, it is False.
Location
▸ Location(): Mx3dGePoint
Obtain the position points of the local coordinate system on the surface.
Returns
Surface location points.
Inherited from
Mx3dGeomElementarySurface.Location
MirrorByAxis
▸ MirrorByAxis(A1): void
Mirror transform geometric objects through axes.
Parameters
| Name | Type | Description |
|---|---|---|
| A1 | [Mx3dGeAxis] (Mx3dGeAxis. md) | Axis object |
Returns
void
Inherited from
Mx3dGeomElementarySurface.MirrorByAxis
MirrorByCSYSR
▸ MirrorByCSYSR(A2): void
Mirror transform geometric objects using a right-handed coordinate system.
Parameters
| Name | Type | Description |
|---|---|---|
| A2 | [Mx3dGeCSYSR] (Mx3dGeCSYSR. md) | Right hand coordinate system object |
Returns
void
Inherited from
Mx3dGeomElementarySurface.MirrorByCSYSR
MirrorByPoint
▸ MirrorByPoint(P): void
Mirror transform geometric objects through points.
Parameters
| Name | Type | Description |
|---|---|---|
| P | [Mx3dGePoint] (Mx3dGePoint. md) | Point object |
Returns
void
Inherited from
Mx3dGeomElementarySurface.MirrorByPoint
MirroredByAxis
▸ MirroredByAxis(A1): Mx3dGeomSphericalSurface
Return the new geometric object transformed through axis mirroring.
Parameters
| Name | Type | Description |
|---|---|---|
| A1 | [Mx3dGeAxis] (Mx3dGeAxis. md) | Axis object |
Returns
New geometric objects.
Inherited from
Mx3dGeomElementarySurface.MirroredByAxis
MirroredByCSYSR
▸ MirroredByCSYSR(A2): Mx3dGeomSphericalSurface
Return the new geometric object after mirror transformation through the right-handed coordinate system.
Parameters
| Name | Type | Description |
|---|---|---|
| A2 | [Mx3dGeCSYSR] (Mx3dGeCSYSR. md) | Right hand coordinate system object |
Returns
New geometric objects.
Inherited from
Mx3dGeomElementarySurface.MirroredByCSYSR
MirroredByPoint
▸ MirroredByPoint(P): Mx3dGeomSphericalSurface
Return the new geometric object after point mirror transformation.
Parameters
| Name | Type | Description |
|---|---|---|
| P | [Mx3dGePoint] (Mx3dGePoint. md) | Point object |
Returns
New geometric objects.
Inherited from
Mx3dGeomElementarySurface.MirroredByPoint
Position
▸ Position(): Mx3dGeCSYSR
Obtain the local coordinate system of the surface.
Returns
The local coordinate system of the surface.
Inherited from
Mx3dGeomElementarySurface.Position
Radius
▸ Radius(): number
Return the radius of the sphere.
Returns
number
The radius of the ball.
Rotate
▸ Rotate(A1, Ang): void
Rotate geometric objects.
Parameters
| Name | Type | Description |
|---|---|---|
| A1 | [Mx3dGeAxis] (Mx3dGeAxis. md) | Axis object |
| Ang | number | Rotation angle |
Returns
void
Inherited from
Mx3dGeomElementarySurface.Rotate
Rotated
▸ Rotated(A1, Ang): Mx3dGeomSphericalSurface
Return the rotated new geometric object.
Parameters
| Name | Type | Description |
|---|---|---|
| A1 | [Mx3dGeAxis] (Mx3dGeAxis. md) | Axis object |
| Ang | number | Rotation angle |
Returns
New geometric objects.
Inherited from
Mx3dGeomElementarySurface.Rotated
Scale
▸ Scale(P, S): void
Scale geometric objects.
Parameters
| Name | Type | Description |
|---|---|---|
| P | [Mx3dGePoint] (Mx3dGePoint. md) | Point object |
| S | number | scaling ratio |
Returns
void
Inherited from
Mx3dGeomElementarySurface.Scale
Scaled
▸ Scaled(P, S): Mx3dGeomSphericalSurface
Return the scaled new geometric object.
Parameters
| Name | Type | Description |
|---|---|---|
| P | [Mx3dGePoint] (Mx3dGePoint. md) | Point object |
| S | number | scaling ratio |
Returns
New geometric objects.
Inherited from
Mx3dGeomElementarySurface.Scaled
SetAxis
▸ SetAxis(theA1): void
Set the main axis (Z-axis) of the surface.
Parameters
| Name | Type | Description |
|---|---|---|
| TheA1 | [Mx3dGeAxis] (Mx3dGeAxis. md) | Definition of the principal axis of the surface |
Returns
void
Inherited from
Mx3dGeomElementarySurface.SetAxis
SetLocation
▸ SetLocation(theLoc): void
Set the position points of the surface local coordinate system.
Parameters
| Name | Type | Description |
|---|---|---|
| TheLoc | [Mx3dGePoint] (Mx3dGePoint. md) | New location point |
Returns
void
Inherited from
Mx3dGeomElementarySurface.SetLocation
SetPosition
▸ SetPosition(theAx3): void
Set the local coordinate system of the surface.
Parameters
| Name | Type | Description |
|---|---|---|
| TheAx3 | [Mx3dGeCSYSR] (Mx3dGeCSYSR. md) | A new coordinate system that includes position and orientation |
Returns
void
Inherited from
Mx3dGeomElementarySurface.SetPosition
SetRadius
▸ SetRadius(R): void
Set the spherical radius.
Parameters
| Name | Type | Description |
|---|---|---|
| R | number | New spherical radius. It must be non negative |
Returns
void
Transform
▸ Transform(T): void
Apply transformation to a sphere.
Parameters
| Name | Type | Description |
|---|---|---|
| T | [Mx3dGetStrf] (Mx3dGetStrf. md) | The transformation to be applied |
Returns
void
TransformParameters
▸ TransformParameters(UV, T): void
Transform the surface parameters according to the given transformation matrix T.
Parameters
| Name | Type | Description |
|---|---|---|
| UV | [dU: number, dV: number] | Parameter array containing the values of U and V |
| T | [Mx3dGetStrf] (Mx3dGetStrf. md) | Transform matrix |
Returns
void
Inherited from
Mx3dGeomElementarySurface.TransformParameters
Transformed
▸ Transformed(T): Mx3dGeomSphericalSurface
Return the transformed new geometric object.
Parameters
| Name | Type | Description |
|---|---|---|
| T | [Mx3dGetStrf] (Mx3dGetStrf. md) | Transform the object |
Returns
New geometric objects.
Inherited from
Mx3dGeomElementarySurface.Transformed
TranslateBy2Points
▸ TranslateBy2Points(P1, P2): void
Translate geometric objects through two points.
Parameters
| Name | Type | Description |
|---|---|---|
| P1 | [Mx3dGePoint] (Mx3dGePoint. md) | Starting point object |
| P2 | [Mx3dGePoint] (Mx3dGePoint. md) | End point object |
Returns
void
Inherited from
Mx3dGeomElementarySurface.TranslateBy2Points
TranslateByVec
▸ TranslateByVec(V): void
Translate geometric objects through vectors.
Parameters
| Name | Type | Description |
|---|---|---|
| V | [Mx3dGeVec] (Mx3dGeVec. md) | Vector object |
Returns
void
Inherited from
Mx3dGeomElementarySurface.TranslateByVec
TranslatedBy2Points
▸ TranslatedBy2Points(P1, P2): Mx3dGeomSphericalSurface
Return the new geometric object after translating through two points.
Parameters
| Name | Type | Description |
|---|---|---|
| P1 | [Mx3dGePoint] (Mx3dGePoint. md) | Starting point object |
| P2 | [Mx3dGePoint] (Mx3dGePoint. md) | End point object |
Returns
New geometric objects.
Inherited from
Mx3dGeomElementarySurface.TranslatedBy2Points
TranslatedByVec
▸ TranslatedByVec(V): Mx3dGeomSphericalSurface
Return the new geometric object after vector translation.
Parameters
| Name | Type | Description |
|---|---|---|
| V | [Mx3dGeVec] (Mx3dGeVec. md) | Vector object |
Returns
New geometric objects.
Inherited from
Mx3dGeomElementarySurface.TranslatedByVec
UPeriod
▸ UPeriod(): number
Return the period of the surface in the U direction.
Returns
number
The period of the surface in the U direction.
Inherited from
Mx3dGeomElementarySurface.UPeriod
UReverse
▸ UReverse(): void
Reverse the parameterization direction of the surface in the U parameter direction.
Returns
void
Inherited from
Mx3dGeomElementarySurface.UReverse
UReversed
▸ UReversed(): Mx3dGeomSphericalSurface
Parameterization of reversing the U direction.
Returns
Return the current object to implement a chain call.
Inherited from
Mx3dGeomElementarySurface.UReversed
UReversedParameter
▸ UReversedParameter(U): number
Calculate the U-parameter value after reversing the U-parameter direction at a given point.
Parameters
| Name | Type | Description |
|---|---|---|
| U | number | The original U parameter |
Returns
number
The inverted U parameter value.
VPeriod
▸ VPeriod(): number
Return the period of the surface in the V direction.
Returns
number
The period of the surface in the V direction.
Inherited from
Mx3dGeomElementarySurface.VPeriod
VReverse
▸ VReverse(): void
Reverse the parameterization direction of the surface in the V parameter direction.
Returns
void
Inherited from
Mx3dGeomElementarySurface.VReverse
VReversed
▸ VReversed(): Mx3dGeomSphericalSurface
Parameterization of reversing the V direction.
Returns
Return the current object to implement a chain call.
Inherited from
Mx3dGeomElementarySurface.VReversed
VReversedParameter
▸ VReversedParameter(V): number
Calculate the value of the V parameter after reversing its direction at a given point.
Parameters
| Name | Type | Description |
|---|---|---|
| V | number | The original V parameter |
Returns
number
The inverted value of the V parameter.
Value
▸ Value(U, V): Mx3dGePoint
Calculate the points on the surface corresponding to the parameters (U, V).
Parameters
| Name | Type | Description |
|---|---|---|
| U | number | Surface parameter U |
| V | number | Surface parameter V |
Returns
Corresponding point.
Inherited from
Mx3dGeomElementarySurface.Value
Volume
▸ Volume(): number
Calculate the volume of the sphere.
Returns
number
Surface volume.
DownCast
▸ Static DownCast(theObject): Mx3dGeomSphericalSurface
Convert parent class object to Mx3dGeomSphericalSurface class object
Parameters
| Name | Type | Description |
|---|---|---|
| TheObject | [Mx3dGeomObject] (Mx3dGeomObject. md) | Parent class object |
Returns
Mx3dGeomSphericalSurface class object