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

Class: Mx3dMkFace

The class representing the modeling surface inherits from Mx3dMkObject.

Hierarchy

• Mx3dMkObject

  ↳ Mx3dMkFace

Table of contents

Constructors

• constructor

Methods

• Add
• Build
• Face
• IsDone
• Shape

Constructors

constructor

• new Mx3dMkFace(theWire, OnlyPlane?)

Constructor that accepts a Wire object and a Boolean value to initialize a face object.

Parameters

Name	Type	Default value	Description
The Wire	[Mx3dShapeFace. md] \	[Mx3dShapeWire] (Mx3dShapeWire. md)	undefined
OnlyPlane	boolean	false	Whether it is limited to flat construction only, defaults to false

Overrides

Mx3dMkObject.constructor

Methods

Add

▸ Add(W): void

Parameters

Name	Type
W	Mx3dShapeWire

Returns

void

---

Build

▸ Build(): void

Modeling algorithm for execution surface.

Returns

void

---

Face

▸ Face(): Mx3dShapeFace

Obtain the specific object of the face.

Returns

Mx3dShapeFace

The specific object of the face.

---

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 shape object of the face.

Returns

Mx3dShapeObject

Shape object of the face.