[mxcad_3d API Document](../README. md)/Mx3dGeomElementarySurface

Class: Mx3dGeomElementarySurface

The Mx3dGeomElementarySurface class encapsulates the Elementary Surface class and provides an interface for operating on surfaces with simple parameter equations. These surfaces include planes, cylinders, cones, spheres, etc. This class inherits from Mx3dGeomSurface and extends related geometric operation functions.

Hierarchy

• Mx3dGeomSurface

  ↳ Mx3dGeomElementarySurface

  ↳↳ Mx3dGeomPlane

  ↳↳ Mx3dGeomConicalSurface

  ↳↳ Mx3dGeomCylindricalSurface

  ↳↳ Mx3dGeomSphericalSurface

  ↳↳ Mx3dGeomToroidalSurface

Table of contents

Methods

• Axis
• Continuity
• DynCast
• DynamicType
• IsCNu
• IsCNv
• Location
• MirrorByAxis
• MirrorByCSYSR
• MirrorByPoint
• MirroredByAxis
• MirroredByCSYSR
• MirroredByPoint
• Position
• Rotate
• Rotated
• Scale
• Scaled
• SetAxis
• SetLocation
• SetPosition
• TransformParameters
• Transformed
• TranslateBy2Points
• TranslateByVec
• TranslatedBy2Points
• TranslatedByVec
• UPeriod
• UReverse
• UReversed
• VPeriod
• VReverse
• VReversed
• Value

Methods

Axis

▸ Axis(): Mx3dGeAxis

Obtain the main axis (Z-axis) of the surface.

Returns

Mx3dGeAxis

Definition of the main axis on the surface.

---

Continuity

▸ Continuity(): MxGAShapeEnum

Return the global continuity of the surface (MxGAShapeenum).

Returns

MxGAShapeEnum

The continuity of the surface on a global scale.

---

DynCast

▸ DynCast(theObject): Mx3dGeomElementarySurface

Parameters

Name	Type
theObject	Mx3dGeomObject

Returns

Mx3dGeomElementarySurface

Inherited from

Mx3dGeomSurface.DynCast

---

DynamicType

▸ DynamicType(): string

Return the dynamic type name of the object.

Returns

string

The type name string of the object.

Overrides

Mx3dGeomSurface.DynamicType

---

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.

---

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.

---

Location

▸ Location(): Mx3dGePoint

Obtain the position points of the local coordinate system on the surface.

Returns

Mx3dGePoint

Surface location points.

---

MirrorByAxis

▸ MirrorByAxis(A1): void

Mirror transform geometric objects through axes.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object

Returns

void

Inherited from

Mx3dGeomSurface.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

Mx3dGeomSurface.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

Mx3dGeomSurface.MirrorByPoint

---

MirroredByAxis

▸ MirroredByAxis(A1): Mx3dGeomElementarySurface

Return the new geometric object transformed through axis mirroring.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object

Returns

Mx3dGeomElementarySurface

New geometric objects.

Inherited from

Mx3dGeomSurface.MirroredByAxis

---

MirroredByCSYSR

▸ MirroredByCSYSR(A2): Mx3dGeomElementarySurface

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

Mx3dGeomElementarySurface

New geometric objects.

Inherited from

Mx3dGeomSurface.MirroredByCSYSR

---

MirroredByPoint

▸ MirroredByPoint(P): Mx3dGeomElementarySurface

Return the new geometric object after point mirror transformation.

Parameters

Name	Type	Description
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object

Returns

Mx3dGeomElementarySurface

New geometric objects.

Inherited from

Mx3dGeomSurface.MirroredByPoint

---

Position

▸ Position(): Mx3dGeCSYSR

Obtain the local coordinate system of the surface.

Returns

Mx3dGeCSYSR

The local coordinate system of the surface.

---

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

Mx3dGeomSurface.Rotate

---

Rotated

▸ Rotated(A1, Ang): Mx3dGeomElementarySurface

Return the rotated new geometric object.

Parameters

Name	Type	Description
A1	[Mx3dGeAxis] (Mx3dGeAxis. md)	Axis object
Ang	number	Rotation angle

Returns

Mx3dGeomElementarySurface

New geometric objects.

Inherited from

Mx3dGeomSurface.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

Mx3dGeomSurface.Scale

---

Scaled

▸ Scaled(P, S): Mx3dGeomElementarySurface

Return the scaled new geometric object.

Parameters

Name	Type	Description
P	[Mx3dGePoint] (Mx3dGePoint. md)	Point object
S	number	scaling ratio

Returns

Mx3dGeomElementarySurface

New geometric objects.

Inherited from

Mx3dGeomSurface.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

---

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

---

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

---

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

Mx3dGeomSurface.TransformParameters

---

Transformed

▸ Transformed(T): Mx3dGeomElementarySurface

Return the transformed new geometric object.

Parameters

Name	Type	Description
T	[Mx3dGetStrf] (Mx3dGetStrf. md)	Transform the object

Returns

Mx3dGeomElementarySurface

New geometric objects.

Inherited from

Mx3dGeomSurface.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

Mx3dGeomSurface.TranslateBy2Points

---

TranslateByVec

▸ TranslateByVec(V): void

Translate geometric objects through vectors.

Parameters

Name	Type	Description
V	[Mx3dGeVec] (Mx3dGeVec. md)	Vector object

Returns

void

Inherited from

Mx3dGeomSurface.TranslateByVec

---

TranslatedBy2Points

▸ TranslatedBy2Points(P1, P2): Mx3dGeomElementarySurface

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

Mx3dGeomElementarySurface

New geometric objects.

Inherited from

Mx3dGeomSurface.TranslatedBy2Points

---

TranslatedByVec

▸ TranslatedByVec(V): Mx3dGeomElementarySurface

Return the new geometric object after vector translation.

Parameters

Name	Type	Description
V	[Mx3dGeVec] (Mx3dGeVec. md)	Vector object

Returns

Mx3dGeomElementarySurface

New geometric objects.

Inherited from

Mx3dGeomSurface.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

Mx3dGeomSurface.UPeriod

---

UReverse

▸ UReverse(): void

Reverse the parameterization direction of the surface in the U parameter direction.

Returns

void

---

UReversed

▸ UReversed(): Mx3dGeomElementarySurface

Parameterization of reversing the U direction.

Returns

Mx3dGeomElementarySurface

Return the current object to implement a chain call.

Inherited from

Mx3dGeomSurface.UReversed

---

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

Mx3dGeomSurface.VPeriod

---

VReverse

▸ VReverse(): void

Reverse the parameterization direction of the surface in the V parameter direction.

Returns

void

---

VReversed

▸ VReversed(): Mx3dGeomElementarySurface

Parameterization of reversing the V direction.

Returns

Mx3dGeomElementarySurface

Return the current object to implement a chain call.

Inherited from

Mx3dGeomSurface.VReversed

---

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

Mx3dGePoint

Corresponding point.

Inherited from

Mx3dGeomSurface.Value