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

Class: Mx3dDimRadius

Hierarchy

• Mx3dDimObject

  ↳ Mx3dDimRadius

Table of contents

Constructors

• constructor

Methods

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

Constructors

constructor

• new Mx3dDimRadius(theCircle)

Construct radius dimensions for the specified circle.

Parameters

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

Overrides

Mx3dDimObject.constructor

• new Mx3dDimRadius(theCircle, theAnchorPoint)

Construct a radius dimension for a specified circle and orient it according to the given anchor points.

Parameters

Name	Type	Description
The Circle	[Mx3dGeCircle] (Mx3dGeCircle. md)	The circle to be measured
The AnchorPoint	[Mx3dGePoint] (Mx3dGePoint. md)	The anchor point used for orientation must be located on a circle

Overrides

Mx3dDimObject.constructor

Methods

AnchorPoint

▸ AnchorPoint(): Mx3dGePoint

Obtain anchor points on the circle for this radius dimension.

Returns

Mx3dGePoint

Return the anchor point on the circle.

---

Circle

▸ Circle(): Mx3dGeCircle

Get the circle being measured.

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

Obtain the dimension plane.

Returns

Mx3dGePlane

Return to the dimension plane.

---

GetTextPosition

▸ GetTextPosition(): Mx3dGePoint

Get the text location.

Returns

Mx3dGePoint

Return the text location.

---

GetValue

▸ GetValue(): number

Obtain size values.

Returns

number

Return the size value.

---

IsTextPositionCustom

▸ IsTextPositionCustom(): boolean

Check if the text position is customized.

Returns

boolean

Return whether it is a custom text location.

---

IsValid

▸ IsValid(): boolean

Check if the radius size is valid.

Returns

boolean

Return whether it is valid.

---

KindOfDimension

▸ KindOfDimension(): MxKindOfDimension

Obtain the size type.

Returns

MxKindOfDimension

Return size type.

---

SelToleranceForText2d

▸ SelToleranceForText2d(): number

Obtain 2D text selection tolerance.

Returns

number

Return 2D text to select tolerance.

---

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	Custom size value

Returns

void

---

SetDimensionAspect

▸ SetDimensionAspect(theDimensionAspect): void

Set the appearance of the size.

Parameters

Name	Type	Description
TheDimensionAspect	[Mx3dAspectDim] (Mx3dAspectDim. md)	Appearance of dimensions

Returns

void

---

SetFlyout

▸ SetFlyout(theFlyout): void

Set the position distance of the dimension line.

Parameters

Name	Type	Description
The Flyout	Number	Position distance of the dimension line

Returns

void

---

SetMeasuredGeometry

▸ SetMeasuredGeometry(theCircle): void

Set the circle for measurement.

Parameters

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

Returns

void

▸ SetMeasuredGeometry(theCircle, theAnchorPoint, theHasAnchor): void

Set the measured circle and specify the anchor point.

Parameters

Name	Type	Description
The Circle	[Mx3dGeCircle] (Mx3dGeCircle. md)	The circle to be measured
The AnchorPoint	[Mx3dGePoint] (Mx3dGePoint. md)	The anchor point used for orientation must be located on a circle
'theHasAnchor '	' boolean '	Whether to use anchor points

Returns

void

---

SetSelToleranceForText2d

▸ SetSelToleranceForText2d(theTol): void

Set 2D text selection tolerance.

Parameters

Name	Type	Description
TheTol	Number	2D text selection tolerance

Returns

void

---

SetTextPosition

▸ SetTextPosition(theTextPos): void

Set the text position.

Parameters

Name	Type	Description
TheTextPos	[Mx3dGePoint] (Mx3dGePoint. md)	The position of the text

Returns

void

---

Shape

▸ Shape(): Mx3dShapeObject

Obtain the measured shape.

Returns

Mx3dShapeObject

Return the measured shape.

---

UnsetCustomPlane

▸ UnsetCustomPlane(): void

Cancel custom plane.

Returns

void

---

UnsetFixedTextPosition

▸ UnsetFixedTextPosition(): void

Cancel fixed text position.

Returns

void