[mxcad_3d API documentation](../README. md)/Mx3dDimDiameter

Class: Mx3dDimDiameter

Hierarchy

• Mx3dDimObject

  ↳ Mx3dDimDiameter

Table of contents

Constructors

• constructor

Methods

• AnchorPoint
• Circle
• GetFlyout
• GetGeometryType
• GetPlane
• GetTextPosition
• GetValue
• IsTextPositionCustom
• IsValid
• KindOfDimension
• SelToleranceForText2d
• SetComputedValue
• SetCustomPlane
• SetCustomValue
• SetDimensionAspect
• SetDisplayUnits
• SetFlyout
• SetMeasuredGeometry
• SetModelUnits
• SetSelToleranceForText2d
• SetTextPosition
• Shape
• UnsetCustomPlane
• UnsetFixedTextPosition

Constructors

constructor

• new Mx3dDimDiameter(theCircle)

Construct diameter dimensions for the specified circle.

Parameters

Name	Type	Description
The Circle	[Mx3dGeCircle] (Mx3dGeCircle. md)	The circle to be measured

Overrides

Mx3dDimObject.constructor

• new Mx3dDimDiameter(theCircle, thePlane)

Construct a diameter dimension for a specified circle and orient it according to a given plane.

Parameters

Name	Type	Description
The Circle	[Mx3dGeCircle] (Mx3dGeCircle. md)	The circle to be measured
ThePlane	[Mx3dGePlane] (Mx3dGePlane. md)	Define the preferred orientation plane for size

Overrides

Mx3dDimObject.constructor

Methods

AnchorPoint

▸ AnchorPoint(): Mx3dGePoint

Returns

Mx3dGePoint

Return the anchor point on the circle for this diameter dimension.

---

Circle

▸ Circle(): Mx3dGeCircle

Returns

Mx3dGeCircle

Return the circle being measured for this size.

---

GetFlyout

▸ GetFlyout(): number

Obtain the distance of the dimension line position.

Returns

number

Return the distance of the dimension line position.

---

GetGeometryType

▸ GetGeometryType(): number

Get the geometric type.

Returns

number

Return the geometric type.

---

GetPlane

▸ GetPlane(): Mx3dGePlane

Get the current plane.

Returns

Mx3dGePlane

Return to the current plane.

---

GetTextPosition

▸ GetTextPosition(): Mx3dGePoint

Get the text location.

Returns

Mx3dGePoint

Return the text location point.

---

GetValue

▸ GetValue(): number

Get the current size value.

Returns

number

Return the current size value.

---

IsTextPositionCustom

▸ IsTextPositionCustom(): boolean

Determine whether the text position is customized.

Returns

boolean

Returns a Boolean value indicating whether the text position is custom.

---

IsValid

▸ IsValid(): boolean

Determine if the current size is valid.

Returns

boolean

Return a Boolean value indicating whether the size is valid.

---

KindOfDimension

▸ KindOfDimension(): MxKindOfDimension

Obtain the size type.

Returns

MxKindOfDimension

Return size type.

---

SelToleranceForText2d

▸ SelToleranceForText2d(): number

Obtain the selection tolerance for 2D text.

Returns

number

Return the selection tolerance of two-dimensional text.

---

SetComputedValue

▸ SetComputedValue(): void

Set the calculated size value.

Returns

void

---

SetCustomPlane

▸ SetCustomPlane(thePlane): void

Set a custom plane.

Parameters

Name	Type	Description
ThePlane	[Mx3dGePlane] (Mx3dGePlane. md)	Custom Plane

Returns

void

---

SetCustomValue

▸ SetCustomValue(theValue): void

Set custom size values.

Parameters

Name	Type	Description
theValue	number	Customize size values

Returns

void

---

SetDimensionAspect

▸ SetDimensionAspect(theDimensionAspect): void

Set the display appearance of the size.

Parameters

Name	Type	Description
TheDimensionAspect	[Mx3dAspectDim] (Mx3dAspectDim. md)	Size and appearance

Returns

void

---

SetDisplayUnits

▸ SetDisplayUnits(theUnits): void

Set display units.

Parameters

Name	Type	Description
TheUnits	String	Unit string

Returns

void

---

SetFlyout

▸ SetFlyout(theFlyout): void

Set the position distance of the dimension line.

Parameters

Name	Type	Description
The Flyout	number	dimension line position distance value

Returns

void

---

SetMeasuredGeometry

▸ SetMeasuredGeometry(theCircle): void

Set the geometry to be measured.

Parameters

Name	Type	Description
The Circle	[Mx3dGeCircle] (Mx3dGeCircle. md)	The circle to be measured

Returns

void

---

SetModelUnits

▸ SetModelUnits(theUnits): void

Set model units.

Parameters

Name	Type	Description
TheUnits	String	Unit string

Returns

void

---

SetSelToleranceForText2d

▸ SetSelToleranceForText2d(theTol): void

Set the selection tolerance for 2D text.

Parameters

Name	Type	Description
TheTol	Number	Tolerance value

Returns

void

---

SetTextPosition

▸ SetTextPosition(theTextPos): void

Set the text position.

Parameters

Name	Type	Description
TheTextPos	[Mx3dGePoint] (Mx3dGePoint. md)	Text position point

Returns

void

---

Shape

▸ Shape(): Mx3dShapeObject

Returns

Mx3dShapeObject

Return the shape object being measured.

---

UnsetCustomPlane

▸ UnsetCustomPlane(): void

Cancel custom plane.

Returns

void

---

UnsetFixedTextPosition

▸ UnsetFixedTextPosition(): void

Cancel fixed text position.

Returns

void