@mlightcad/data-model 1.1.2 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (259) hide show
  1. package/dist/data-model.js +5490 -1022
  2. package/dist/data-model.umd.cjs +2 -2
  3. package/lib/base/AcDbHostApplicationServices.d.ts +72 -6
  4. package/lib/base/AcDbHostApplicationServices.d.ts.map +1 -1
  5. package/lib/base/AcDbHostApplicationServices.js +71 -7
  6. package/lib/base/AcDbHostApplicationServices.js.map +1 -1
  7. package/lib/base/AcDbObject.d.ts +160 -25
  8. package/lib/base/AcDbObject.d.ts.map +1 -1
  9. package/lib/base/AcDbObject.js +149 -25
  10. package/lib/base/AcDbObject.js.map +1 -1
  11. package/lib/converter/AcDbBatchProcessing.d.ts +112 -10
  12. package/lib/converter/AcDbBatchProcessing.d.ts.map +1 -1
  13. package/lib/converter/AcDbBatchProcessing.js +110 -11
  14. package/lib/converter/AcDbBatchProcessing.js.map +1 -1
  15. package/lib/converter/AcDbDxfConverter.d.ts +224 -6
  16. package/lib/converter/AcDbDxfConverter.d.ts.map +1 -1
  17. package/lib/converter/AcDbDxfConverter.js +224 -6
  18. package/lib/converter/AcDbDxfConverter.js.map +1 -1
  19. package/lib/converter/AcDbDxfParseWorker.d.ts +16 -0
  20. package/lib/converter/AcDbDxfParseWorker.d.ts.map +1 -1
  21. package/lib/converter/AcDbDxfParseWorker.js +16 -0
  22. package/lib/converter/AcDbDxfParseWorker.js.map +1 -1
  23. package/lib/converter/AcDbEntitiyConverter.d.ts +118 -3
  24. package/lib/converter/AcDbEntitiyConverter.d.ts.map +1 -1
  25. package/lib/converter/AcDbEntitiyConverter.js +118 -3
  26. package/lib/converter/AcDbEntitiyConverter.js.map +1 -1
  27. package/lib/converter/AcDbObjectConverter.d.ts +52 -0
  28. package/lib/converter/AcDbObjectConverter.d.ts.map +1 -1
  29. package/lib/converter/AcDbObjectConverter.js +52 -0
  30. package/lib/converter/AcDbObjectConverter.js.map +1 -1
  31. package/lib/database/AcDbBlockTable.d.ts +35 -3
  32. package/lib/database/AcDbBlockTable.d.ts.map +1 -1
  33. package/lib/database/AcDbBlockTable.js +35 -3
  34. package/lib/database/AcDbBlockTable.js.map +1 -1
  35. package/lib/database/AcDbBlockTableRecord.d.ts +98 -15
  36. package/lib/database/AcDbBlockTableRecord.d.ts.map +1 -1
  37. package/lib/database/AcDbBlockTableRecord.js +96 -15
  38. package/lib/database/AcDbBlockTableRecord.js.map +1 -1
  39. package/lib/database/AcDbDatabase.d.ts +303 -33
  40. package/lib/database/AcDbDatabase.d.ts.map +1 -1
  41. package/lib/database/AcDbDatabase.js +223 -39
  42. package/lib/database/AcDbDatabase.js.map +1 -1
  43. package/lib/database/AcDbDatabaseConverter.d.ts +77 -12
  44. package/lib/database/AcDbDatabaseConverter.d.ts.map +1 -1
  45. package/lib/database/AcDbDatabaseConverter.js +46 -13
  46. package/lib/database/AcDbDatabaseConverter.js.map +1 -1
  47. package/lib/database/AcDbDatabaseConverterManager.d.ts +97 -15
  48. package/lib/database/AcDbDatabaseConverterManager.d.ts.map +1 -1
  49. package/lib/database/AcDbDatabaseConverterManager.js +90 -15
  50. package/lib/database/AcDbDatabaseConverterManager.js.map +1 -1
  51. package/lib/database/AcDbDimStyleTable.d.ts +22 -2
  52. package/lib/database/AcDbDimStyleTable.d.ts.map +1 -1
  53. package/lib/database/AcDbDimStyleTable.js +22 -2
  54. package/lib/database/AcDbDimStyleTable.js.map +1 -1
  55. package/lib/database/AcDbDimStyleTableRecord.d.ts +115 -0
  56. package/lib/database/AcDbDimStyleTableRecord.d.ts.map +1 -1
  57. package/lib/database/AcDbDimStyleTableRecord.js +44 -0
  58. package/lib/database/AcDbDimStyleTableRecord.js.map +1 -1
  59. package/lib/database/AcDbLayerTable.d.ts +39 -2
  60. package/lib/database/AcDbLayerTable.d.ts.map +1 -1
  61. package/lib/database/AcDbLayerTable.js +39 -2
  62. package/lib/database/AcDbLayerTable.js.map +1 -1
  63. package/lib/database/AcDbLayerTableRecord.d.ts +198 -18
  64. package/lib/database/AcDbLayerTableRecord.d.ts.map +1 -1
  65. package/lib/database/AcDbLayerTableRecord.js +182 -19
  66. package/lib/database/AcDbLayerTableRecord.js.map +1 -1
  67. package/lib/database/AcDbLinetypeTable.d.ts +21 -2
  68. package/lib/database/AcDbLinetypeTable.d.ts.map +1 -1
  69. package/lib/database/AcDbLinetypeTable.js +21 -2
  70. package/lib/database/AcDbLinetypeTable.js.map +1 -1
  71. package/lib/database/AcDbLinetypeTableRecord.d.ts +46 -14
  72. package/lib/database/AcDbLinetypeTableRecord.d.ts.map +1 -1
  73. package/lib/database/AcDbLinetypeTableRecord.js +46 -14
  74. package/lib/database/AcDbLinetypeTableRecord.js.map +1 -1
  75. package/lib/database/AcDbSymbolTable.d.ts +134 -29
  76. package/lib/database/AcDbSymbolTable.d.ts.map +1 -1
  77. package/lib/database/AcDbSymbolTable.js +133 -37
  78. package/lib/database/AcDbSymbolTable.js.map +1 -1
  79. package/lib/database/AcDbSymbolTableRecord.d.ts +47 -2
  80. package/lib/database/AcDbSymbolTableRecord.d.ts.map +1 -1
  81. package/lib/database/AcDbSymbolTableRecord.js +40 -2
  82. package/lib/database/AcDbSymbolTableRecord.js.map +1 -1
  83. package/lib/database/AcDbTextStyleTable.d.ts +36 -2
  84. package/lib/database/AcDbTextStyleTable.d.ts.map +1 -1
  85. package/lib/database/AcDbTextStyleTable.js +36 -2
  86. package/lib/database/AcDbTextStyleTable.js.map +1 -1
  87. package/lib/database/AcDbTextStyleTableRecord.d.ts +129 -17
  88. package/lib/database/AcDbTextStyleTableRecord.d.ts.map +1 -1
  89. package/lib/database/AcDbTextStyleTableRecord.js +127 -17
  90. package/lib/database/AcDbTextStyleTableRecord.js.map +1 -1
  91. package/lib/database/AcDbViewportTable.d.ts +22 -2
  92. package/lib/database/AcDbViewportTable.d.ts.map +1 -1
  93. package/lib/database/AcDbViewportTable.js +22 -2
  94. package/lib/database/AcDbViewportTable.js.map +1 -1
  95. package/lib/database/AcDbViewportTableRecord.d.ts +74 -9
  96. package/lib/database/AcDbViewportTableRecord.d.ts.map +1 -1
  97. package/lib/database/AcDbViewportTableRecord.js +65 -9
  98. package/lib/database/AcDbViewportTableRecord.js.map +1 -1
  99. package/lib/entity/AcDbArc.d.ts +202 -17
  100. package/lib/entity/AcDbArc.d.ts.map +1 -1
  101. package/lib/entity/AcDbArc.js +201 -17
  102. package/lib/entity/AcDbArc.js.map +1 -1
  103. package/lib/entity/AcDbBlockReference.d.ts +147 -13
  104. package/lib/entity/AcDbBlockReference.d.ts.map +1 -1
  105. package/lib/entity/AcDbBlockReference.js +142 -13
  106. package/lib/entity/AcDbBlockReference.js.map +1 -1
  107. package/lib/entity/AcDbCircle.d.ts +145 -12
  108. package/lib/entity/AcDbCircle.d.ts.map +1 -1
  109. package/lib/entity/AcDbCircle.js +144 -12
  110. package/lib/entity/AcDbCircle.js.map +1 -1
  111. package/lib/entity/AcDbCurve.d.ts +33 -2
  112. package/lib/entity/AcDbCurve.d.ts.map +1 -1
  113. package/lib/entity/AcDbCurve.js +17 -0
  114. package/lib/entity/AcDbCurve.js.map +1 -1
  115. package/lib/entity/AcDbEllipse.d.ts +168 -16
  116. package/lib/entity/AcDbEllipse.d.ts.map +1 -1
  117. package/lib/entity/AcDbEllipse.js +167 -16
  118. package/lib/entity/AcDbEllipse.js.map +1 -1
  119. package/lib/entity/AcDbEntity.d.ts +299 -35
  120. package/lib/entity/AcDbEntity.d.ts.map +1 -1
  121. package/lib/entity/AcDbEntity.js +275 -27
  122. package/lib/entity/AcDbEntity.js.map +1 -1
  123. package/lib/entity/AcDbHatch.d.ts +60 -4
  124. package/lib/entity/AcDbHatch.d.ts.map +1 -1
  125. package/lib/entity/AcDbHatch.js +52 -4
  126. package/lib/entity/AcDbHatch.js.map +1 -1
  127. package/lib/entity/AcDbLeader.d.ts +157 -10
  128. package/lib/entity/AcDbLeader.d.ts.map +1 -1
  129. package/lib/entity/AcDbLeader.js +149 -10
  130. package/lib/entity/AcDbLeader.js.map +1 -1
  131. package/lib/entity/AcDbLine.d.ts +154 -13
  132. package/lib/entity/AcDbLine.d.ts.map +1 -1
  133. package/lib/entity/AcDbLine.js +153 -13
  134. package/lib/entity/AcDbLine.js.map +1 -1
  135. package/lib/entity/AcDbMText.d.ts +127 -11
  136. package/lib/entity/AcDbMText.d.ts.map +1 -1
  137. package/lib/entity/AcDbMText.js +112 -11
  138. package/lib/entity/AcDbMText.js.map +1 -1
  139. package/lib/entity/AcDbPoint.d.ts +86 -7
  140. package/lib/entity/AcDbPoint.d.ts.map +1 -1
  141. package/lib/entity/AcDbPoint.js +85 -7
  142. package/lib/entity/AcDbPoint.js.map +1 -1
  143. package/lib/entity/AcDbPolyline.d.ts +172 -25
  144. package/lib/entity/AcDbPolyline.d.ts.map +1 -1
  145. package/lib/entity/AcDbPolyline.js +170 -25
  146. package/lib/entity/AcDbPolyline.js.map +1 -1
  147. package/lib/entity/AcDbRasterImage.d.ts +75 -31
  148. package/lib/entity/AcDbRasterImage.d.ts.map +1 -1
  149. package/lib/entity/AcDbRasterImage.js +60 -31
  150. package/lib/entity/AcDbRasterImage.js.map +1 -1
  151. package/lib/entity/AcDbRay.d.ts +115 -9
  152. package/lib/entity/AcDbRay.d.ts.map +1 -1
  153. package/lib/entity/AcDbRay.js +113 -9
  154. package/lib/entity/AcDbRay.js.map +1 -1
  155. package/lib/entity/AcDbSpline.d.ts +106 -14
  156. package/lib/entity/AcDbSpline.d.ts.map +1 -1
  157. package/lib/entity/AcDbSpline.js +67 -4
  158. package/lib/entity/AcDbSpline.js.map +1 -1
  159. package/lib/entity/AcDbTable.d.ts +161 -44
  160. package/lib/entity/AcDbTable.d.ts.map +1 -1
  161. package/lib/entity/AcDbTable.js +135 -44
  162. package/lib/entity/AcDbTable.js.map +1 -1
  163. package/lib/entity/AcDbText.d.ts +298 -25
  164. package/lib/entity/AcDbText.d.ts.map +1 -1
  165. package/lib/entity/AcDbText.js +288 -25
  166. package/lib/entity/AcDbText.js.map +1 -1
  167. package/lib/entity/AcDbTrace.d.ts +150 -23
  168. package/lib/entity/AcDbTrace.d.ts.map +1 -1
  169. package/lib/entity/AcDbTrace.js +147 -23
  170. package/lib/entity/AcDbTrace.js.map +1 -1
  171. package/lib/entity/AcDbViewport.d.ts +122 -9
  172. package/lib/entity/AcDbViewport.d.ts.map +1 -1
  173. package/lib/entity/AcDbViewport.js +122 -9
  174. package/lib/entity/AcDbViewport.js.map +1 -1
  175. package/lib/entity/AcDbWipeout.d.ts +29 -1
  176. package/lib/entity/AcDbWipeout.d.ts.map +1 -1
  177. package/lib/entity/AcDbWipeout.js +29 -1
  178. package/lib/entity/AcDbWipeout.js.map +1 -1
  179. package/lib/entity/AcDbXline.d.ts +116 -9
  180. package/lib/entity/AcDbXline.d.ts.map +1 -1
  181. package/lib/entity/AcDbXline.js +114 -9
  182. package/lib/entity/AcDbXline.js.map +1 -1
  183. package/lib/entity/dimension/AcDb3PointAngularDimension.d.ts +56 -12
  184. package/lib/entity/dimension/AcDb3PointAngularDimension.d.ts.map +1 -1
  185. package/lib/entity/dimension/AcDb3PointAngularDimension.js +56 -12
  186. package/lib/entity/dimension/AcDb3PointAngularDimension.js.map +1 -1
  187. package/lib/entity/dimension/AcDbAlignedDimension.d.ts +158 -17
  188. package/lib/entity/dimension/AcDbAlignedDimension.d.ts.map +1 -1
  189. package/lib/entity/dimension/AcDbAlignedDimension.js +153 -17
  190. package/lib/entity/dimension/AcDbAlignedDimension.js.map +1 -1
  191. package/lib/entity/dimension/AcDbArcDimension.d.ts +58 -12
  192. package/lib/entity/dimension/AcDbArcDimension.d.ts.map +1 -1
  193. package/lib/entity/dimension/AcDbArcDimension.js +58 -12
  194. package/lib/entity/dimension/AcDbArcDimension.js.map +1 -1
  195. package/lib/entity/dimension/AcDbDiametricDimension.d.ts +99 -25
  196. package/lib/entity/dimension/AcDbDiametricDimension.d.ts.map +1 -1
  197. package/lib/entity/dimension/AcDbDiametricDimension.js +99 -25
  198. package/lib/entity/dimension/AcDbDiametricDimension.js.map +1 -1
  199. package/lib/entity/dimension/AcDbDimension.d.ts +108 -14
  200. package/lib/entity/dimension/AcDbDimension.d.ts.map +1 -1
  201. package/lib/entity/dimension/AcDbDimension.js +99 -14
  202. package/lib/entity/dimension/AcDbDimension.js.map +1 -1
  203. package/lib/entity/dimension/AcDbOrdinateDimension.d.ts +48 -16
  204. package/lib/entity/dimension/AcDbOrdinateDimension.d.ts.map +1 -1
  205. package/lib/entity/dimension/AcDbOrdinateDimension.js +48 -16
  206. package/lib/entity/dimension/AcDbOrdinateDimension.js.map +1 -1
  207. package/lib/entity/dimension/AcDbRadialDimension.d.ts +167 -24
  208. package/lib/entity/dimension/AcDbRadialDimension.d.ts.map +1 -1
  209. package/lib/entity/dimension/AcDbRadialDimension.js +162 -24
  210. package/lib/entity/dimension/AcDbRadialDimension.js.map +1 -1
  211. package/lib/misc/AcDbAngleUnits.d.ts +12 -0
  212. package/lib/misc/AcDbAngleUnits.d.ts.map +1 -1
  213. package/lib/misc/AcDbAngleUnits.js +12 -0
  214. package/lib/misc/AcDbAngleUnits.js.map +1 -1
  215. package/lib/misc/AcDbConstants.d.ts +20 -0
  216. package/lib/misc/AcDbConstants.d.ts.map +1 -1
  217. package/lib/misc/AcDbConstants.js +20 -0
  218. package/lib/misc/AcDbConstants.js.map +1 -1
  219. package/lib/misc/AcDbDimArrowType.d.ts +24 -21
  220. package/lib/misc/AcDbDimArrowType.d.ts.map +1 -1
  221. package/lib/misc/AcDbDimArrowType.js +24 -21
  222. package/lib/misc/AcDbDimArrowType.js.map +1 -1
  223. package/lib/misc/AcDbObjectIterator.d.ts +42 -3
  224. package/lib/misc/AcDbObjectIterator.d.ts.map +1 -1
  225. package/lib/misc/AcDbObjectIterator.js +42 -3
  226. package/lib/misc/AcDbObjectIterator.js.map +1 -1
  227. package/lib/misc/AcDbOsnapMode.d.ts +18 -10
  228. package/lib/misc/AcDbOsnapMode.d.ts.map +1 -1
  229. package/lib/misc/AcDbOsnapMode.js +18 -10
  230. package/lib/misc/AcDbOsnapMode.js.map +1 -1
  231. package/lib/misc/AcDbRenderingCache.d.ts +107 -29
  232. package/lib/misc/AcDbRenderingCache.d.ts.map +1 -1
  233. package/lib/misc/AcDbRenderingCache.js +105 -29
  234. package/lib/misc/AcDbRenderingCache.js.map +1 -1
  235. package/lib/misc/AcDbUnitsValue.d.ts +58 -8
  236. package/lib/misc/AcDbUnitsValue.d.ts.map +1 -1
  237. package/lib/misc/AcDbUnitsValue.js +58 -8
  238. package/lib/misc/AcDbUnitsValue.js.map +1 -1
  239. package/lib/object/AcDbDictionary.d.ts +128 -30
  240. package/lib/object/AcDbDictionary.d.ts.map +1 -1
  241. package/lib/object/AcDbDictionary.js +126 -30
  242. package/lib/object/AcDbDictionary.js.map +1 -1
  243. package/lib/object/AcDbRasterImageDef.d.ts +38 -9
  244. package/lib/object/AcDbRasterImageDef.d.ts.map +1 -1
  245. package/lib/object/AcDbRasterImageDef.js +37 -9
  246. package/lib/object/AcDbRasterImageDef.js.map +1 -1
  247. package/lib/object/layout/AcDbLayout.d.ts +152 -13
  248. package/lib/object/layout/AcDbLayout.d.ts.map +1 -1
  249. package/lib/object/layout/AcDbLayout.js +146 -13
  250. package/lib/object/layout/AcDbLayout.js.map +1 -1
  251. package/lib/object/layout/AcDbLayoutDictionary.d.ts +35 -7
  252. package/lib/object/layout/AcDbLayoutDictionary.d.ts.map +1 -1
  253. package/lib/object/layout/AcDbLayoutDictionary.js +35 -7
  254. package/lib/object/layout/AcDbLayoutDictionary.js.map +1 -1
  255. package/lib/object/layout/AcDbLayoutManager.d.ts +103 -31
  256. package/lib/object/layout/AcDbLayoutManager.d.ts.map +1 -1
  257. package/lib/object/layout/AcDbLayoutManager.js +98 -31
  258. package/lib/object/layout/AcDbLayoutManager.js.map +1 -1
  259. package/package.json +4 -4
@@ -27,21 +27,65 @@ var __assign = (this && this.__assign) || function () {
27
27
  import { AcGeBox3d, AcGeLine3d, AcGePoint3d, AcGeVector3d } from '@mlightcad/geometry-engine';
28
28
  import { AcDbDimension } from './AcDbDimension';
29
29
  /**
30
- * This class represents the dimension type that dimensions the distance between two points located anywhere
31
- * in space. The dimension's normal vector must be perpendicular to the line between the two points. The two
32
- * selected points are also used as the definition points for the start of the two dimension extension lines.
30
+ * Represents an aligned dimension entity in AutoCAD.
31
+ *
32
+ * An aligned dimension measures the distance between two points located anywhere in space.
33
+ * The dimension's normal vector must be perpendicular to the line between the two points.
34
+ * The two selected points are also used as the definition points for the start of the
35
+ * two dimension extension lines.
36
+ *
37
+ * Aligned dimensions are commonly used to measure distances that are not parallel to
38
+ * the X or Y axes, providing accurate measurements regardless of the orientation.
39
+ *
40
+ * @example
41
+ * ```typescript
42
+ * // Create an aligned dimension
43
+ * const alignedDim = new AcDbAlignedDimension(
44
+ * new AcGePoint3d(0, 0, 0), // First extension line point
45
+ * new AcGePoint3d(10, 5, 0), // Second extension line point
46
+ * new AcGePoint3d(5, 2.5, 0), // Dimension line point
47
+ * "10.0", // Dimension text
48
+ * "Standard" // Dimension style
49
+ * );
50
+ *
51
+ * // Access dimension properties
52
+ * console.log(`Dimension line point: ${alignedDim.dimLinePoint}`);
53
+ * console.log(`Extension line 1 point: ${alignedDim.xLine1Point}`);
54
+ * console.log(`Extension line 2 point: ${alignedDim.xLine2Point}`);
55
+ * ```
33
56
  */
34
57
  var AcDbAlignedDimension = /** @class */ (function (_super) {
35
58
  __extends(AcDbAlignedDimension, _super);
36
59
  /**
37
- * This constructor uses the parameters passed in to initialize the dimension. In addition, the extension
38
- * line obliquing angle is set to 0.0.
39
- * - If dimStyle is left as null, then the current default dimStyle within the AutoCAD editor is used.
40
- * @param xLine1Point Input start point (in WCS coordinates) of first extension line
41
- * @param xLine2Point Input start point (in WCS coordinates) of second extension line
42
- * @param dimLinePoint Input point (in WCS coordinates) on dimension line itself
43
- * @param dimText Input text string to use as the dimension annotation
44
- * @param dimStyle Input string name of dimension style table record to use
60
+ * Creates a new aligned dimension entity.
61
+ *
62
+ * This constructor initializes an aligned dimension using the specified points.
63
+ * The extension line obliquing angle is set to 0.0 by default.
64
+ *
65
+ * @param xLine1Point - Start point (in WCS coordinates) of first extension line
66
+ * @param xLine2Point - Start point (in WCS coordinates) of second extension line
67
+ * @param dimLinePoint - Point (in WCS coordinates) on dimension line itself
68
+ * @param dimText - Text string to use as the dimension annotation (optional)
69
+ * @param dimStyle - String name of dimension style table record to use (optional)
70
+ *
71
+ * @example
72
+ * ```typescript
73
+ * // Create an aligned dimension with default text and style
74
+ * const alignedDim = new AcDbAlignedDimension(
75
+ * new AcGePoint3d(0, 0, 0),
76
+ * new AcGePoint3d(10, 5, 0),
77
+ * new AcGePoint3d(5, 2.5, 0)
78
+ * );
79
+ *
80
+ * // Create an aligned dimension with custom text and style
81
+ * const alignedDim2 = new AcDbAlignedDimension(
82
+ * new AcGePoint3d(0, 0, 0),
83
+ * new AcGePoint3d(15, 10, 0),
84
+ * new AcGePoint3d(7.5, 5, 0),
85
+ * "15.0",
86
+ * "Architectural"
87
+ * );
88
+ * ```
45
89
  */
46
90
  function AcDbAlignedDimension(xLine1Point, xLine2Point, dimLinePoint, dimText, dimStyle) {
47
91
  if (dimText === void 0) { dimText = null; }
@@ -59,12 +103,32 @@ var AcDbAlignedDimension = /** @class */ (function (_super) {
59
103
  }
60
104
  Object.defineProperty(AcDbAlignedDimension.prototype, "dimLinePoint", {
61
105
  /**
62
- * The definition point (in WCS coordinates) that specifies where the dimension line will be. This point
63
- * will be somewhere on the dimension line.
106
+ * Gets the definition point that specifies where the dimension line will be.
107
+ *
108
+ * This point will be somewhere on the dimension line and determines the position
109
+ * of the dimension text and arrows.
110
+ *
111
+ * @returns The dimension line point in WCS coordinates
112
+ *
113
+ * @example
114
+ * ```typescript
115
+ * const dimLinePoint = alignedDim.dimLinePoint;
116
+ * console.log(`Dimension line point: ${dimLinePoint.x}, ${dimLinePoint.y}, ${dimLinePoint.z}`);
117
+ * ```
64
118
  */
65
119
  get: function () {
66
120
  return this._dimLinePoint;
67
121
  },
122
+ /**
123
+ * Sets the definition point that specifies where the dimension line will be.
124
+ *
125
+ * @param value - The new dimension line point
126
+ *
127
+ * @example
128
+ * ```typescript
129
+ * alignedDim.dimLinePoint = new AcGePoint3d(5, 2.5, 0);
130
+ * ```
131
+ */
68
132
  set: function (value) {
69
133
  this._dimLinePoint.copy(value);
70
134
  },
@@ -73,11 +137,29 @@ var AcDbAlignedDimension = /** @class */ (function (_super) {
73
137
  });
74
138
  Object.defineProperty(AcDbAlignedDimension.prototype, "xLine1Point", {
75
139
  /**
76
- * The start point for the first extension line of the dimension.
140
+ * Gets the start point for the first extension line of the dimension.
141
+ *
142
+ * @returns The first extension line point in WCS coordinates
143
+ *
144
+ * @example
145
+ * ```typescript
146
+ * const xLine1Point = alignedDim.xLine1Point;
147
+ * console.log(`Extension line 1 point: ${xLine1Point.x}, ${xLine1Point.y}, ${xLine1Point.z}`);
148
+ * ```
77
149
  */
78
150
  get: function () {
79
151
  return this._xLine1Point;
80
152
  },
153
+ /**
154
+ * Sets the start point for the first extension line of the dimension.
155
+ *
156
+ * @param value - The new first extension line point
157
+ *
158
+ * @example
159
+ * ```typescript
160
+ * alignedDim.xLine1Point = new AcGePoint3d(0, 0, 0);
161
+ * ```
162
+ */
81
163
  set: function (value) {
82
164
  this._xLine1Point.copy(value);
83
165
  },
@@ -86,11 +168,29 @@ var AcDbAlignedDimension = /** @class */ (function (_super) {
86
168
  });
87
169
  Object.defineProperty(AcDbAlignedDimension.prototype, "xLine2Point", {
88
170
  /**
89
- * The start point for the second extension line of the dimension.
171
+ * Gets the start point for the second extension line of the dimension.
172
+ *
173
+ * @returns The second extension line point in WCS coordinates
174
+ *
175
+ * @example
176
+ * ```typescript
177
+ * const xLine2Point = alignedDim.xLine2Point;
178
+ * console.log(`Extension line 2 point: ${xLine2Point.x}, ${xLine2Point.y}, ${xLine2Point.z}`);
179
+ * ```
90
180
  */
91
181
  get: function () {
92
182
  return this._xLine2Point;
93
183
  },
184
+ /**
185
+ * Sets the start point for the second extension line of the dimension.
186
+ *
187
+ * @param value - The new second extension line point
188
+ *
189
+ * @example
190
+ * ```typescript
191
+ * alignedDim.xLine2Point = new AcGePoint3d(10, 5, 0);
192
+ * ```
193
+ */
94
194
  set: function (value) {
95
195
  this._xLine2Point.copy(value);
96
196
  },
@@ -99,11 +199,29 @@ var AcDbAlignedDimension = /** @class */ (function (_super) {
99
199
  });
100
200
  Object.defineProperty(AcDbAlignedDimension.prototype, "rotation", {
101
201
  /**
102
- * The dimension's rotation angle in radians.
202
+ * Gets the dimension's rotation angle.
203
+ *
204
+ * @returns The rotation angle in radians
205
+ *
206
+ * @example
207
+ * ```typescript
208
+ * const rotation = alignedDim.rotation;
209
+ * console.log(`Rotation: ${rotation} radians (${rotation * 180 / Math.PI} degrees)`);
210
+ * ```
103
211
  */
104
212
  get: function () {
105
213
  return this._rotation;
106
214
  },
215
+ /**
216
+ * Sets the dimension's rotation angle.
217
+ *
218
+ * @param value - The new rotation angle in radians
219
+ *
220
+ * @example
221
+ * ```typescript
222
+ * alignedDim.rotation = Math.PI / 4; // 45 degrees
223
+ * ```
224
+ */
107
225
  set: function (value) {
108
226
  this._rotation = value;
109
227
  },
@@ -112,11 +230,29 @@ var AcDbAlignedDimension = /** @class */ (function (_super) {
112
230
  });
113
231
  Object.defineProperty(AcDbAlignedDimension.prototype, "oblique", {
114
232
  /**
115
- * The extension line obliquing angle (in radians) for the dimension.
233
+ * Gets the extension line obliquing angle.
234
+ *
235
+ * @returns The obliquing angle in radians
236
+ *
237
+ * @example
238
+ * ```typescript
239
+ * const oblique = alignedDim.oblique;
240
+ * console.log(`Oblique angle: ${oblique} radians`);
241
+ * ```
116
242
  */
117
243
  get: function () {
118
244
  return this._oblique;
119
245
  },
246
+ /**
247
+ * Sets the extension line obliquing angle.
248
+ *
249
+ * @param value - The new obliquing angle in radians
250
+ *
251
+ * @example
252
+ * ```typescript
253
+ * alignedDim.oblique = Math.PI / 6; // 30 degrees
254
+ * ```
255
+ */
120
256
  set: function (value) {
121
257
  this._oblique = value;
122
258
  },
@@ -1 +1 @@
1
- {"version":3,"file":"AcDbAlignedDimension.js","sourceRoot":"","sources":["../../../src/entity/dimension/AcDbAlignedDimension.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,UAAU,EACV,WAAW,EAEX,YAAY,EACb,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;;GAIG;AACH;IAA0C,wCAAa;IAOrD;;;;;;;;;OASG;IACH,8BACE,WAA0B,EAC1B,WAA0B,EAC1B,YAA2B,EAC3B,OAA6B,EAC7B,QAA8B;QAD9B,wBAAA,EAAA,cAA6B;QAC7B,yBAAA,EAAA,eAA8B;QAE9B,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvD,KAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;QACjB,KAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAElB,KAAI,CAAC,aAAa,GAAG,OAAO,CAAA;QAC5B,6FAA6F;QAC7F,KAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAA;;IACpC,CAAC;IAMD,sBAAI,8CAAY;QAJhB;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;aACD,UAAiB,KAAkB;YACjC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;;;OAHA;IAQD,sBAAI,6CAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAQD,sBAAI,6CAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAQD,sBAAI,0CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;aACD,UAAa,KAAa;YACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACxB,CAAC;;;OAHA;IAQD,sBAAI,yCAAO;QAHX;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAA;QACtB,CAAC;aACD,UAAY,KAAa;YACvB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAA;QACvB,CAAC;;;OAHA;IAQD,sBAAI,kDAAgB;QAHpB;;WAEG;aACH;YACE,kBAAkB;YAClB,OAAO,IAAI,SAAS,EAAE,CAAA;QACxB,CAAC;;;OAAA;IAKD,sBAAc,+CAAa;QAH3B;;WAEG;aACH;YACE,OAAO,KAAK,CAAA;QACd,CAAC;;;OAAA;IAED;;;;;OAKG;IACO,6CAAc,GAAxB;QACE,IAAM,KAAK,GAAiB,EAAE,CAAA;QAE9B,IAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAClE,IAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAElE,IAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CACnD,cAAc,EACd,IAAI,CAAC,aAAa,CACnB,CAAA;QACD,IAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CACnD,cAAc,EACd,IAAI,CAAC,aAAa,CACnB,CAAA;QACD,IAAM,aAAa,GAAG,IAAI,UAAU,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAA;QAC5E,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAEzB,iDAAiD;QACjD,cAAc,CAAC,QAAQ,GAAG,kBAAkB,CAAA;QAC5C,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAA;QACxC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAE1B,kDAAkD;QAClD,cAAc,CAAC,QAAQ,GAAG,kBAAkB,CAAA;QAC5C,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAA;QACxC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAE1B,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,kDAAmB,GAA3B,UAA4B,KAAkB;QAC5C,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAA;QACzC,IAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;QAC7D,OAAO,IAAI,UAAU,CAAC,KAAK,wBAAO,YAAY,KAAE,CAAC,EAAE,KAAK,CAAC,CAAC,IAAG,CAAA;IAC/D,CAAC;IAED;;;;;;;OAOG;IACK,oDAAqB,GAA7B,UAA8B,KAAiB,EAAE,CAAe;QAC9D,IAAM,EAAE,GAAG,KAAK,CAAC,UAAU,CAAA;QAC3B,IAAM,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAA;QAEzB,+BAA+B;QAC/B,IAAM,gBAAgB,GAAG,IAAI,YAAY,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,CAAA;QAE1E,uCAAuC;QACvC,IAAM,gBAAgB,GAAG,IAAI,YAAY,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QAE7D,gEAAgE;QAChE,IAAM,gBAAgB,GAAG,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;QAC/D,IAAM,gBAAgB,GAAG,IAAI,YAAY,EAAE;aACxC,IAAI,CAAC,gBAAgB,CAAC;aACtB,cAAc,CAAC,gBAAgB,CAAC,CAAA;QAEnC,8DAA8D;QAC9D,IAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAA;QAExE,OAAO,YAAY,CAAA;IACrB,CAAC;IACH,2BAAC;AAAD,CAAC,AA7KD,CAA0C,aAAa,GA6KtD"}
1
+ {"version":3,"file":"AcDbAlignedDimension.js","sourceRoot":"","sources":["../../../src/entity/dimension/AcDbAlignedDimension.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,UAAU,EACV,WAAW,EAEX,YAAY,EACb,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH;IAA0C,wCAAa;IAYrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,8BACE,WAA0B,EAC1B,WAA0B,EAC1B,YAA2B,EAC3B,OAA6B,EAC7B,QAA8B;QAD9B,wBAAA,EAAA,cAA6B;QAC7B,yBAAA,EAAA,eAA8B;QAE9B,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACzD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvD,KAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;QACjB,KAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAElB,KAAI,CAAC,aAAa,GAAG,OAAO,CAAA;QAC5B,6FAA6F;QAC7F,KAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAA;;IACpC,CAAC;IAgBD,sBAAI,8CAAY;QAdhB;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;QAED;;;;;;;;;WASG;aACH,UAAiB,KAAkB;YACjC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAChC,CAAC;;;OAdA;IA2BD,sBAAI,6CAAW;QAXf;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;QAED;;;;;;;;;WASG;aACH,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAdA;IA2BD,sBAAI,6CAAW;QAXf;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;QAED;;;;;;;;;WASG;aACH,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAdA;IA2BD,sBAAI,0CAAQ;QAXZ;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAa,KAAa;YACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACxB,CAAC;;;OAdA;IA2BD,sBAAI,yCAAO;QAXX;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,QAAQ,CAAA;QACtB,CAAC;QAED;;;;;;;;;WASG;aACH,UAAY,KAAa;YACvB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAA;QACvB,CAAC;;;OAdA;IAmBD,sBAAI,kDAAgB;QAHpB;;WAEG;aACH;YACE,kBAAkB;YAClB,OAAO,IAAI,SAAS,EAAE,CAAA;QACxB,CAAC;;;OAAA;IAKD,sBAAc,+CAAa;QAH3B;;WAEG;aACH;YACE,OAAO,KAAK,CAAA;QACd,CAAC;;;OAAA;IAED;;;;;OAKG;IACO,6CAAc,GAAxB;QACE,IAAM,KAAK,GAAiB,EAAE,CAAA;QAE9B,IAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAClE,IAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAElE,IAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CACnD,cAAc,EACd,IAAI,CAAC,aAAa,CACnB,CAAA;QACD,IAAM,kBAAkB,GAAG,IAAI,CAAC,qBAAqB,CACnD,cAAc,EACd,IAAI,CAAC,aAAa,CACnB,CAAA;QACD,IAAM,aAAa,GAAG,IAAI,UAAU,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAA;QAC5E,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAEzB,iDAAiD;QACjD,cAAc,CAAC,QAAQ,GAAG,kBAAkB,CAAA;QAC5C,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAA;QACxC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAE1B,kDAAkD;QAClD,cAAc,CAAC,QAAQ,GAAG,kBAAkB,CAAA;QAC5C,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAA;QACxC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAE1B,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,kDAAmB,GAA3B,UAA4B,KAAkB;QAC5C,IAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,CAAA;QACzC,IAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;QAC7D,OAAO,IAAI,UAAU,CAAC,KAAK,wBAAO,YAAY,KAAE,CAAC,EAAE,KAAK,CAAC,CAAC,IAAG,CAAA;IAC/D,CAAC;IAED;;;;;;;OAOG;IACK,oDAAqB,GAA7B,UAA8B,KAAiB,EAAE,CAAe;QAC9D,IAAM,EAAE,GAAG,KAAK,CAAC,UAAU,CAAA;QAC3B,IAAM,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAA;QAEzB,+BAA+B;QAC/B,IAAM,gBAAgB,GAAG,IAAI,YAAY,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,CAAA;QAE1E,uCAAuC;QACvC,IAAM,gBAAgB,GAAG,IAAI,YAAY,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QAE7D,gEAAgE;QAChE,IAAM,gBAAgB,GAAG,gBAAgB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;QAC/D,IAAM,gBAAgB,GAAG,IAAI,YAAY,EAAE;aACxC,IAAI,CAAC,gBAAgB,CAAC;aACtB,cAAc,CAAC,gBAAgB,CAAC,CAAA;QAEnC,8DAA8D;QAC9D,IAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAA;QAExE,OAAO,YAAY,CAAA;IACrB,CAAC;IACH,2BAAC;AAAD,CAAC,AAxSD,CAA0C,aAAa,GAwStD"}
@@ -1,7 +1,15 @@
1
1
  import { AcGeBox3d, AcGePoint3d, AcGePoint3dLike } from '@mlightcad/geometry-engine';
2
2
  import { AcDbDimension } from './AcDbDimension';
3
3
  /**
4
- * This class represents an arc length dimension.
4
+ * Represents an arc length dimension entity in AutoCAD.
5
+ *
6
+ * This dimension type measures the length of an arc by defining the arc's center point,
7
+ * two points that define the arc's extent, and a point on the arc itself. Arc length
8
+ * dimensions are commonly used in mechanical drawings, architectural plans, and other
9
+ * technical documentation where precise arc measurements are required.
10
+ *
11
+ * The dimension displays the actual arc length value and typically includes extension
12
+ * lines, dimension lines, and arrows positioned to clearly indicate the arc being measured.
5
13
  */
6
14
  export declare class AcDbArcDimension extends AcDbDimension {
7
15
  private _arcPoint;
@@ -9,36 +17,74 @@ export declare class AcDbArcDimension extends AcDbDimension {
9
17
  private _xLine1Point;
10
18
  private _xLine2Point;
11
19
  /**
12
- * Create one instance of this class.
13
- * @param centerPoint Input the center of the arc being dimensioned
14
- * @param xLine1Point Input the first extension line end point
15
- * @param xLine2Point Input the second extension line end point
16
- * @param arcPoint Input point on arc being dimensioned
17
- * @param dimText Input dimension text to use instead of calculated value
18
- * @param dimStyle Input string name of dimension style table record to use
20
+ * Creates a new arc length dimension.
21
+ *
22
+ * @param centerPoint - The center point of the arc being measured. This defines
23
+ * the center of the circle that contains the arc
24
+ * @param xLine1Point - The first extension line end point. This defines one end
25
+ * of the arc being measured
26
+ * @param xLine2Point - The second extension line end point. This defines the other
27
+ * end of the arc being measured
28
+ * @param arcPoint - A point on the arc that helps define the specific arc segment
29
+ * being measured. This point is typically between the two extension
30
+ * line points
31
+ * @param dimText - Optional custom dimension text to display instead of the calculated
32
+ * arc length value. If null, the calculated length will be displayed
33
+ * @param dimStyle - Optional name of the dimension style table record to use for
34
+ * formatting. If null, the current default style will be used
19
35
  */
20
36
  constructor(centerPoint: AcGePoint3dLike, xLine1Point: AcGePoint3dLike, xLine2Point: AcGePoint3dLike, arcPoint: AcGePoint3dLike, dimText?: string | null, dimStyle?: string | null);
21
37
  /**
22
- * A point on the arc length dimension's dimension arc.
38
+ * Gets or sets a point on the arc that helps define the arc segment being measured.
39
+ *
40
+ * This point is typically positioned between the two extension line points and helps
41
+ * determine which arc segment should be measured when multiple arcs could be defined
42
+ * by the same center and end points.
43
+ *
44
+ * @returns The arc point that defines the arc segment
23
45
  */
24
46
  get arcPoint(): AcGePoint3d;
25
47
  set arcPoint(value: AcGePoint3d);
26
48
  /**
27
- * The center point of the arc dimensioned by the arc length dimension.
49
+ * Gets or sets the center point of the arc being measured.
50
+ *
51
+ * The center point defines the center of the circle that contains the arc. This point
52
+ * is used to calculate the arc length and position the dimension elements correctly.
53
+ *
54
+ * @returns The center point of the arc
28
55
  */
29
56
  get centerPoint(): AcGePoint3d;
30
57
  set centerPoint(value: AcGePoint3d);
31
58
  /**
32
- * The start point for the first extension line of the dimension.
59
+ * Gets or sets the first extension line end point.
60
+ *
61
+ * This point defines one end of the arc being measured. The extension line extends
62
+ * from this point to the arc, helping to clearly identify the starting point of
63
+ * the arc length measurement.
64
+ *
65
+ * @returns The first extension line end point
33
66
  */
34
67
  get xLine1Point(): AcGePoint3d;
35
68
  set xLine1Point(value: AcGePoint3d);
36
69
  /**
37
- * The start point for the second extension line of the dimension.
70
+ * Gets or sets the second extension line end point.
71
+ *
72
+ * This point defines the other end of the arc being measured. The extension line
73
+ * extends from this point to the arc, helping to clearly identify the ending point
74
+ * of the arc length measurement.
75
+ *
76
+ * @returns The second extension line end point
38
77
  */
39
78
  get xLine2Point(): AcGePoint3d;
40
79
  set xLine2Point(value: AcGePoint3d);
41
80
  /**
81
+ * Gets the geometric extents (bounding box) of this dimension entity.
82
+ *
83
+ * The geometric extents define the minimum bounding box that completely contains
84
+ * the dimension entity, including all its components like extension lines,
85
+ * dimension lines, arrows, and text.
86
+ *
87
+ * @returns A 3D bounding box containing the dimension entity
42
88
  * @inheritdoc
43
89
  */
44
90
  get geometricExtents(): AcGeBox3d;
@@ -1 +1 @@
1
- {"version":3,"file":"AcDbArcDimension.d.ts","sourceRoot":"","sources":["../../../src/entity/dimension/AcDbArcDimension.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,WAAW,EACX,eAAe,EAChB,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,YAAY,CAAa;IAEjC;;;;;;;;OAQG;gBAED,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,eAAe,EAC5B,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,MAAM,GAAG,IAAW,EAC7B,QAAQ,GAAE,MAAM,GAAG,IAAW;IAahC;;OAEG;IACH,IAAI,QAAQ,IAGQ,WAAW,CAD9B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,WAAW,EAE9B;IAED;;OAEG;IACH,IAAI,WAAW,IAGQ,WAAW,CADjC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,EAEjC;IAED;;OAEG;IACH,IAAI,WAAW,IAGQ,WAAW,CADjC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,EAEjC;IAED;;OAEG;IACH,IAAI,WAAW,IAGQ,WAAW,CADjC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,EAEjC;IAED;;OAEG;IACH,IAAI,gBAAgB,cAGnB;CACF"}
1
+ {"version":3,"file":"AcDbArcDimension.d.ts","sourceRoot":"","sources":["../../../src/entity/dimension/AcDbArcDimension.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,WAAW,EACX,eAAe,EAChB,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;;;;;;;;GAUG;AACH,qBAAa,gBAAiB,SAAQ,aAAa;IACjD,OAAO,CAAC,SAAS,CAAa;IAC9B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,YAAY,CAAa;IAEjC;;;;;;;;;;;;;;;;OAgBG;gBAED,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,eAAe,EAC5B,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,MAAM,GAAG,IAAW,EAC7B,QAAQ,GAAE,MAAM,GAAG,IAAW;IAahC;;;;;;;;OAQG;IACH,IAAI,QAAQ,IAGQ,WAAW,CAD9B;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,WAAW,EAE9B;IAED;;;;;;;OAOG;IACH,IAAI,WAAW,IAGQ,WAAW,CADjC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,EAEjC;IAED;;;;;;;;OAQG;IACH,IAAI,WAAW,IAGQ,WAAW,CADjC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,EAEjC;IAED;;;;;;;;OAQG;IACH,IAAI,WAAW,IAGQ,WAAW,CADjC;IACD,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,EAEjC;IAED;;;;;;;;;OASG;IACH,IAAI,gBAAgB,cAGnB;CACF"}
@@ -16,18 +16,34 @@ var __extends = (this && this.__extends) || (function () {
16
16
  import { AcGeBox3d, AcGePoint3d } from '@mlightcad/geometry-engine';
17
17
  import { AcDbDimension } from './AcDbDimension';
18
18
  /**
19
- * This class represents an arc length dimension.
19
+ * Represents an arc length dimension entity in AutoCAD.
20
+ *
21
+ * This dimension type measures the length of an arc by defining the arc's center point,
22
+ * two points that define the arc's extent, and a point on the arc itself. Arc length
23
+ * dimensions are commonly used in mechanical drawings, architectural plans, and other
24
+ * technical documentation where precise arc measurements are required.
25
+ *
26
+ * The dimension displays the actual arc length value and typically includes extension
27
+ * lines, dimension lines, and arrows positioned to clearly indicate the arc being measured.
20
28
  */
21
29
  var AcDbArcDimension = /** @class */ (function (_super) {
22
30
  __extends(AcDbArcDimension, _super);
23
31
  /**
24
- * Create one instance of this class.
25
- * @param centerPoint Input the center of the arc being dimensioned
26
- * @param xLine1Point Input the first extension line end point
27
- * @param xLine2Point Input the second extension line end point
28
- * @param arcPoint Input point on arc being dimensioned
29
- * @param dimText Input dimension text to use instead of calculated value
30
- * @param dimStyle Input string name of dimension style table record to use
32
+ * Creates a new arc length dimension.
33
+ *
34
+ * @param centerPoint - The center point of the arc being measured. This defines
35
+ * the center of the circle that contains the arc
36
+ * @param xLine1Point - The first extension line end point. This defines one end
37
+ * of the arc being measured
38
+ * @param xLine2Point - The second extension line end point. This defines the other
39
+ * end of the arc being measured
40
+ * @param arcPoint - A point on the arc that helps define the specific arc segment
41
+ * being measured. This point is typically between the two extension
42
+ * line points
43
+ * @param dimText - Optional custom dimension text to display instead of the calculated
44
+ * arc length value. If null, the calculated length will be displayed
45
+ * @param dimStyle - Optional name of the dimension style table record to use for
46
+ * formatting. If null, the current default style will be used
31
47
  */
32
48
  function AcDbArcDimension(centerPoint, xLine1Point, xLine2Point, arcPoint, dimText, dimStyle) {
33
49
  if (dimText === void 0) { dimText = null; }
@@ -44,7 +60,13 @@ var AcDbArcDimension = /** @class */ (function (_super) {
44
60
  }
45
61
  Object.defineProperty(AcDbArcDimension.prototype, "arcPoint", {
46
62
  /**
47
- * A point on the arc length dimension's dimension arc.
63
+ * Gets or sets a point on the arc that helps define the arc segment being measured.
64
+ *
65
+ * This point is typically positioned between the two extension line points and helps
66
+ * determine which arc segment should be measured when multiple arcs could be defined
67
+ * by the same center and end points.
68
+ *
69
+ * @returns The arc point that defines the arc segment
48
70
  */
49
71
  get: function () {
50
72
  return this._arcPoint;
@@ -57,7 +79,12 @@ var AcDbArcDimension = /** @class */ (function (_super) {
57
79
  });
58
80
  Object.defineProperty(AcDbArcDimension.prototype, "centerPoint", {
59
81
  /**
60
- * The center point of the arc dimensioned by the arc length dimension.
82
+ * Gets or sets the center point of the arc being measured.
83
+ *
84
+ * The center point defines the center of the circle that contains the arc. This point
85
+ * is used to calculate the arc length and position the dimension elements correctly.
86
+ *
87
+ * @returns The center point of the arc
61
88
  */
62
89
  get: function () {
63
90
  return this._centerPoint;
@@ -70,7 +97,13 @@ var AcDbArcDimension = /** @class */ (function (_super) {
70
97
  });
71
98
  Object.defineProperty(AcDbArcDimension.prototype, "xLine1Point", {
72
99
  /**
73
- * The start point for the first extension line of the dimension.
100
+ * Gets or sets the first extension line end point.
101
+ *
102
+ * This point defines one end of the arc being measured. The extension line extends
103
+ * from this point to the arc, helping to clearly identify the starting point of
104
+ * the arc length measurement.
105
+ *
106
+ * @returns The first extension line end point
74
107
  */
75
108
  get: function () {
76
109
  return this._xLine1Point;
@@ -83,7 +116,13 @@ var AcDbArcDimension = /** @class */ (function (_super) {
83
116
  });
84
117
  Object.defineProperty(AcDbArcDimension.prototype, "xLine2Point", {
85
118
  /**
86
- * The start point for the second extension line of the dimension.
119
+ * Gets or sets the second extension line end point.
120
+ *
121
+ * This point defines the other end of the arc being measured. The extension line
122
+ * extends from this point to the arc, helping to clearly identify the ending point
123
+ * of the arc length measurement.
124
+ *
125
+ * @returns The second extension line end point
87
126
  */
88
127
  get: function () {
89
128
  return this._xLine2Point;
@@ -96,6 +135,13 @@ var AcDbArcDimension = /** @class */ (function (_super) {
96
135
  });
97
136
  Object.defineProperty(AcDbArcDimension.prototype, "geometricExtents", {
98
137
  /**
138
+ * Gets the geometric extents (bounding box) of this dimension entity.
139
+ *
140
+ * The geometric extents define the minimum bounding box that completely contains
141
+ * the dimension entity, including all its components like extension lines,
142
+ * dimension lines, arrows, and text.
143
+ *
144
+ * @returns A 3D bounding box containing the dimension entity
99
145
  * @inheritdoc
100
146
  */
101
147
  get: function () {
@@ -1 +1 @@
1
- {"version":3,"file":"AcDbArcDimension.js","sourceRoot":"","sources":["../../../src/entity/dimension/AcDbArcDimension.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,WAAW,EAEZ,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH;IAAsC,oCAAa;IAMjD;;;;;;;;OAQG;IACH,0BACE,WAA4B,EAC5B,WAA4B,EAC5B,WAA4B,EAC5B,QAAyB,EACzB,OAA6B,EAC7B,QAA8B;QAD9B,wBAAA,EAAA,cAA6B;QAC7B,yBAAA,EAAA,eAA8B;QAE9B,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,SAAS,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACjD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAEvD,KAAI,CAAC,aAAa,GAAG,OAAO,CAAA;QAC5B,6FAA6F;QAC7F,KAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAA;;IACpC,CAAC;IAKD,sBAAI,sCAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;aACD,UAAa,KAAkB;YAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5B,CAAC;;;OAHA;IAQD,sBAAI,yCAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAQD,sBAAI,yCAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAQD,sBAAI,yCAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAQD,sBAAI,8CAAgB;QAHpB;;WAEG;aACH;YACE,kBAAkB;YAClB,OAAO,IAAI,SAAS,EAAE,CAAA;QACxB,CAAC;;;OAAA;IACH,uBAAC;AAAD,CAAC,AAjFD,CAAsC,aAAa,GAiFlD"}
1
+ {"version":3,"file":"AcDbArcDimension.js","sourceRoot":"","sources":["../../../src/entity/dimension/AcDbArcDimension.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,EACL,SAAS,EACT,WAAW,EAEZ,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;;;;;;;;GAUG;AACH;IAAsC,oCAAa;IAMjD;;;;;;;;;;;;;;;;OAgBG;IACH,0BACE,WAA4B,EAC5B,WAA4B,EAC5B,WAA4B,EAC5B,QAAyB,EACzB,OAA6B,EAC7B,QAA8B;QAD9B,wBAAA,EAAA,cAA6B;QAC7B,yBAAA,EAAA,eAA8B;QAE9B,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,SAAS,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACjD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvD,KAAI,CAAC,YAAY,GAAG,IAAI,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAEvD,KAAI,CAAC,aAAa,GAAG,OAAO,CAAA;QAC5B,6FAA6F;QAC7F,KAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAA;;IACpC,CAAC;IAWD,sBAAI,sCAAQ;QATZ;;;;;;;;WAQG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;aACD,UAAa,KAAkB;YAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC5B,CAAC;;;OAHA;IAaD,sBAAI,yCAAW;QARf;;;;;;;WAOG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAcD,sBAAI,yCAAW;QATf;;;;;;;;WAQG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAcD,sBAAI,yCAAW;QATf;;;;;;;;WAQG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAA;QAC1B,CAAC;aACD,UAAgB,KAAkB;YAChC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;;;OAHA;IAeD,sBAAI,8CAAgB;QAVpB;;;;;;;;;WASG;aACH;YACE,kBAAkB;YAClB,OAAO,IAAI,SAAS,EAAE,CAAA;QACxB,CAAC;;;OAAA;IACH,uBAAC;AAAD,CAAC,AAvHD,CAAsC,aAAa,GAuHlD"}