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

Class: Mx3dDimLength

Hierarchy

• Mx3dDimObject

  ↳ Mx3dDimLength

Table of contents

Constructors

• constructor

Methods

• FirstPoint
• FirstShape
• GetFlyout
• GetGeometryType
• GetPlane
• GetTextPosition
• GetValue
• IsTextPositionCustom
• IsValid
• KindOfDimension
• SecondPoint
• SecondShape
• SelToleranceForText2d
• SetComputedValue
• SetCustomPlane
• SetCustomValue
• SetDimensionAspect
• SetDirection
• SetFlyout
• SetMeasuredGeometry
• SetMeasuredShapes
• SetSelToleranceForText2d
• SetTextPosition
• UnsetCustomPlane
• UnsetFixedTextPosition

Constructors

constructor

• new Mx3dDimLength()

Construct an empty length dimension object.

Overrides

Mx3dDimObject.constructor

• new Mx3dDimLength(theEdge, thePlane)

Construct length dimensions for specified edges and planes.

Parameters

Name	Type	Description
The Edge	[Mx3dShapeEdge] (Mx3dShapeEdge. md)	The measured edge
The Plane	[Mx3dGePlane] (Mx3dGePlane. md)	The measured plane

Overrides

Mx3dDimObject.constructor

• new Mx3dDimLength(theFirstPoint, theSecondPoint, thePlane)

Construct length dimensions for specified two points and a plane.

Parameters

Name	Type	Description
The FirstPoint	[Mx3dGePoint] (Mx3dGePoint. md)	The first point
The Second Point	[Mx3dGePoint] (Mx3dGePoint. md)	Second Point
The Plane	[Mx3dGePlane] (Mx3dGePlane. md)	The measured plane

Overrides

Mx3dDimObject.constructor

Methods

FirstPoint

▸ FirstPoint(): Mx3dGePoint

Return the first point of the length dimension.

Returns

Mx3dGePoint

The first point.

---

FirstShape

▸ FirstShape(): Mx3dShapeObject

Return the first shape object of length dimension.

Returns

Mx3dShapeObject

The first shape object.

---

GetFlyout

▸ GetFlyout(): number

Obtain the distance of the dimension line position.

Returns

number

Distance of dimension line position.

---

GetGeometryType

▸ GetGeometryType(): number

Get the geometric type.

Returns

number

Geometric type.

---

GetPlane

▸ GetPlane(): Mx3dGePlane

Obtain the measurement plane.

Returns

Mx3dGePlane

Measure the plane.

---

GetTextPosition

▸ GetTextPosition(): Mx3dGePoint

Get the text location.

Returns

Mx3dGePoint

Text location.

---

GetValue

▸ GetValue(): number

Obtain size values.

Returns

number

Size value.

---

IsTextPositionCustom

▸ IsTextPositionCustom(): boolean

Check if the text position is customized.

Returns

boolean

If the text position is customized, return true; Otherwise, return false.

---

IsValid

▸ IsValid(): boolean

Check if the size is valid.

Returns

boolean

If the size is valid, return true; Otherwise, return false.

---

KindOfDimension

▸ KindOfDimension(): MxKindOfDimension

Obtain the size type.

Returns

MxKindOfDimension

Size type.

---

SecondPoint

▸ SecondPoint(): Mx3dGePoint

Return the second point of the length dimension.

Returns

Mx3dGePoint

Second point.

---

SecondShape

▸ SecondShape(): Mx3dShapeObject

Return the second shape object of length dimension.

Returns

Mx3dShapeObject

The second shape object.

---

SelToleranceForText2d

▸ SelToleranceForText2d(): number

Obtain 2D text selection tolerance.

Returns

number

2D text selection tolerance.

---

SetComputedValue

▸ SetComputedValue(): void

Set the calculated 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 values.

Parameters

Name	Type	Description
theValue	number	Custom value

Returns

void

---

SetDimensionAspect

▸ SetDimensionAspect(theDimensionAspect): void

Set the size and appearance.

Parameters

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

Returns

void

---

SetDirection

▸ SetDirection(theDirection, theUseDirection): void

Set custom direction.

Parameters

Name	Type	Description
The Direction	[Mx3dGeDir] (Mx3dGeDir. md)	Direction
theUseDirection	boolean	Whether to use a custom direction

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(theFirstPoint, theSecondPoint, thePlane): void

Set measurement geometry based on specified two points and a plane.

Parameters

Name	Type	Description
The FirstPoint	[Mx3dGePoint] (Mx3dGePoint. md)	The first point
The Second Point	[Mx3dGePoint] (Mx3dGePoint. md)	Second Point
The Plane	[Mx3dGePlane] (Mx3dGePlane. md)	The measured plane

Returns

void

---

SetMeasuredShapes

▸ SetMeasuredShapes(theFirstShape, theSecondShape): void

Set the measurement geometry based on the specified shape.

Parameters

Name	Type	Description
The FirstShape	[Mx3dShapeObject] (Mx3dShapeObject. md)	The first shape object
The Second Shape	[Mx3dShapeObject] (Mx3dShapeObject. md)	Second Shape Object

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)	Text position

Returns

void

---

UnsetCustomPlane

▸ UnsetCustomPlane(): void

Cancel custom plane settings.

Returns

void

---

UnsetFixedTextPosition

▸ UnsetFixedTextPosition(): void

Cancel fixed text position.

Returns

void