@mlightcad/data-model 1.1.2 → 1.1.4

package/lib/entity/AcDbEntity.d.ts

@@ -3,101 +3,365 @@ import { AcGeBox3d, AcGeMatrix3d, AcGePoint3d } from '@mlightcad/geometry-engine
 import { AcGiEntity, AcGiLineStyle, AcGiRenderer } from '@mlightcad/graphic-interface';
 import { AcDbObject } from '../base/AcDbObject';
 import { AcDbOsnapMode } from '../misc';
+/**
+ * Abstract base class for all drawing entities.
+ *
+ * This class provides the fundamental functionality for all drawing entities,
+ * including layer management, color handling, linetype support, visibility,
+ * and geometric operations. All specific entity types (lines, circles, text, etc.)
+ * inherit from this class.
+ *
+ * @example
+ * ```typescript
+ * class MyEntity extends AcDbEntity {
+ *   get geometricExtents(): AcGeBox3d {
+ *     // Implementation for geometric extents
+ *   }
+ *
+ *   draw(renderer: AcGiRenderer): AcGiEntity | undefined {
+ *     // Implementation for drawing
+ *   }
+ * }
+ * ```
+ */
 export declare abstract class AcDbEntity extends AcDbObject {
+    /** The layer name this entity belongs to */
     private _layer;
+    /** The color of this entity */
     private _color;
+    /** The linetype name for this entity */
     private _lineType;
+    /** The line weight for this entity */
     private _lineWeight;
+    /** The linetype scale factor for this entity */
     private _linetypeScale;
+    /** Whether this entity is visible */
     private _visibility;
+    /** The transparency level of this entity (0-1) */
     private _transparency;
+    /**
+     * Gets the type name of this entity.
+     *
+     * This method returns the entity type by removing the "AcDb" prefix
+     * from the constructor name.
+     *
+     * @returns The entity type name
+     *
+     * @example
+     * ```typescript
+     * const entity = new AcDbLine();
+     * console.log(entity.type); // "Line"
+     * ```
+     */
     get type(): string;
     /**
-     * The name of the layer referenced by this entity
+     * Gets the name of the layer referenced by this entity.
+     *
+     * @returns The layer name
+     *
+     * @example
+     * ```typescript
+     * const layerName = entity.layer;
+     * ```
      */
     get layer(): string;
+    /**
+     * Sets the name of the layer for this entity.
+     *
+     * @param value - The new layer name
+     *
+     * @example
+     * ```typescript
+     * entity.layer = 'MyLayer';
+     * ```
+     */
     set layer(value: string);
     /**
-     * The color information of this entity
+     * Gets the color information of this entity.
+     *
+     * @returns The color object for this entity
+     *
+     * @example
+     * ```typescript
+     * const color = entity.color;
+     * ```
      */
     get color(): AcCmColor;
+    /**
+     * Sets the color information for this entity.
+     *
+     * @param value - The new color object
+     *
+     * @example
+     * ```typescript
+     * entity.color = new AcCmColor(0xFF0000);
+     * ```
+     */
     set color(value: AcCmColor);
     /**
-     * The RGB color of this entity after converting color index (including ByLayer and ByBlock) or name to
-     * real RGB color.
+     * Gets the RGB color of this entity after converting color index.
+     *
+     * This method handles the conversion of color indices (including ByLayer and ByBlock)
+     * to actual RGB colors. It resolves layer colors and block colors as needed.
+     *
+     * @returns The RGB color value as a number
+     *
+     * @example
+     * ```typescript
+     * const rgbColor = entity.rgbColor;
+     * console.log(`RGB: ${rgbColor.toString(16)}`);
+     * ```
      */
     get rgbColor(): number;
     /**
-     * The name of the line type referenced by this entity.
+     * Gets the name of the line type referenced by this entity.
+     *
+     * @returns The linetype name
+     *
+     * @example
+     * ```typescript
+     * const lineType = entity.lineType;
+     * ```
      */
     get lineType(): string;
+    /**
+     * Sets the name of the line type for this entity.
+     *
+     * @param value - The new linetype name
+     *
+     * @example
+     * ```typescript
+     * entity.lineType = 'DASHED';
+     * ```
+     */
     set lineType(value: string);
     /**
-     * Line weight used by this entity.
+     * Gets the line weight used by this entity.
+     *
+     * @returns The line weight value
+     *
+     * @example
+     * ```typescript
+     * const weight = entity.lineWeight;
+     * ```
      */
     get lineWeight(): number;
+    /**
+     * Sets the line weight for this entity.
+     *
+     * @param value - The new line weight value
+     *
+     * @example
+     * ```typescript
+     * entity.lineWeight = 2;
+     * ```
+     */
     set lineWeight(value: number);
     /**
-     * The line type scale factor of this entity. When an entity is first instantiated, its line type scale
-     * is initialized to an invalid value. When the entity is added to the database, if a linetype scale has
-     * not been specified for the entity, it is set to the database's current line type scale value.
+     * Gets the line type scale factor of this entity.
+     *
+     * When an entity is first instantiated, its line type scale is initialized
+     * to an invalid value. When the entity is added to the database, if a
+     * linetype scale has not been specified for the entity, it is set to the
+     * database's current line type scale value.
+     *
+     * @returns The linetype scale factor
+     *
+     * @example
+     * ```typescript
+     * const scale = entity.linetypeScale;
+     * ```
      */
     get linetypeScale(): number;
+    /**
+     * Sets the line type scale factor for this entity.
+     *
+     * @param value - The new linetype scale factor
+     *
+     * @example
+     * ```typescript
+     * entity.linetypeScale = 2.0;
+     * ```
+     */
     set linetypeScale(value: number);
     /**
-     * The visibility state of this entity
+     * Gets whether this entity is visible.
+     *
+     * @returns True if the entity is visible, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const isVisible = entity.visibility;
+     * ```
      */
     get visibility(): boolean;
+    /**
+     * Sets whether this entity is visible.
+     *
+     * @param value - True to make the entity visible, false to hide it
+     *
+     * @example
+     * ```typescript
+     * entity.visibility = false; // Hide the entity
+     * ```
+     */
     set visibility(value: boolean);
     /**
-     * The transparency setting of this entity.
+     * Gets the transparency level of this entity.
+     *
+     * @returns The transparency value (0-1, where 0 is opaque and 1 is fully transparent)
+     *
+     * @example
+     * ```typescript
+     * const transparency = entity.transparency;
+     * ```
      */
     get transparency(): number;
+    /**
+     * Sets the transparency level of this entity.
+     *
+     * @param value - The transparency value (0-1, where 0 is opaque and 1 is fully transparent)
+     *
+     * @example
+     * ```typescript
+     * entity.transparency = 0.5; // 50% transparent
+     * ```
+     */
     set transparency(value: number);
     /**
-     * Calculate grip points of this entity and return them.
-     * @returns Return grip points of this entity
+     * Gets the grip points for this entity.
+     *
+     * Grip points are the control points that can be used to modify the entity.
+     * This method should be overridden by subclasses to provide entity-specific
+     * grip points.
+     *
+     * @returns Array of grip points as 3D points
+     *
+     * @example
+     * ```typescript
+     * const gripPoints = entity.subGetGripPoints();
+     * ```
      */
     subGetGripPoints(): AcGePoint3d[];
     /**
-     * This function must use the material provided in osnapMode, gsSelectionMark, pickPoint, lastPoint, and
-     * viewXform to determine all appropriate osnap points for the entity. It must then append all such osnap
-     * points to the snapPoints array.
-     * @param osnapMode Input osnap mode being requested
-     * @param gsSelectionMark Input GS marker of the subentity involved in the object snap operation
-     * @param pickPoint Input point (in WCS coordinates) picked during the object snap operation
-     * @param lastPoint Input point (in WCS coordinates) selected just before pickPoint
-     * @param snapPoints The snapPoints array is passed to all entities involved in the osnap operation, so it's
-     * possible that the array will already have entries in it when passed in. For this reason, it's very important
-     * that points be appended to the snapPoints array instead of assigning to any existing elements.
+     * Gets the object snap points for this entity.
+     *
+     * Object snap points are the points that can be used for precise positioning
+     * when drawing or editing. This method should be overridden by subclasses
+     * to provide entity-specific snap points.
+     *
+     * @param osnapMode - The object snap mode
+     * @param gsSelectionMark - The selection mark
+     * @param pickPoint - The pick point
+     * @param lastPoint - The last point
+     * @param snapPoints - Array to populate with snap points
+     *
+     * @example
+     * ```typescript
+     * const snapPoints: AcGePoint3d[] = [];
+     * entity.subGetOsnapPoints(AcDbOsnapMode.Endpoint, 0, pickPoint, lastPoint, snapPoints);
+     * ```
      */
     subGetOsnapPoints(osnapMode: AcDbOsnapMode, gsSelectionMark: number, pickPoint: AcGePoint3d, lastPoint: AcGePoint3d, snapPoints: AcGePoint3d[]): void;
     /**
-     * Apply a transformation matrix to this entity
-     * @param matrix Input one transformation matrix
-     * @returns Return this entity
+     * Transforms this entity by the specified matrix.
+     *
+     * This method applies a geometric transformation to the entity.
+     * Subclasses should override this method to provide entity-specific
+     * transformation behavior.
+     *
+     * @param matrix - The transformation matrix to apply
+     * @returns This entity after transformation
+     *
+     * @example
+     * ```typescript
+     * const matrix = AcGeMatrix3d.translation(10, 0, 0);
+     * entity.transformBy(matrix);
+     * ```
      */
     transformBy(matrix: AcGeMatrix3d): this;
     /**
-     * Compute the corner points (in WCS coordinates) of a box (with edges parallel to the WCS X, Y,
-     * and Z axes) that encloses the 3D extents of the entity, and return those points as an instance
-     * of class AcDbExtents.
+     * Gets the geometric extents of this entity.
+     *
+     * This method should be implemented by subclasses to return the
+     * bounding box that encompasses the entire entity.
+     *
+     * @returns The geometric extents as a 3D bounding box
+     *
+     * @example
+     * ```typescript
+     * const extents = entity.geometricExtents;
+     * console.log(`Min: ${extents.minPoint}, Max: ${extents.maxPoint}`);
+     * ```
      */
     abstract get geometricExtents(): AcGeBox3d;
     /**
-     * Convert this entity to an object be able to draw by the specified renderer and return it.
-     * @param renderer Input renderer to draw this entity
-     * @returns Return object to render in the scene. Different renderers use different classes to
-     * represent objects to render. So the type of returned object is completely specific to render
-     * engine.
+     * Draws this entity using the specified renderer.
+     *
+     * This method should be implemented by subclasses to provide
+     * entity-specific drawing behavior.
+     *
+     * @param renderer - The renderer to use for drawing
+     * @returns The rendered entity, or undefined if drawing failed
+     *
+     * @example
+     * ```typescript
+     * const renderedEntity = entity.draw(renderer);
+     * ```
      */
     abstract draw(renderer: AcGiRenderer): AcGiEntity | undefined;
     /**
-     * Trigger 'entityModified' event
+     * Triggers a modified event for this entity.
+     *
+     * This method notifies listeners that the entity has been modified.
+     *
+     * @example
+     * ```typescript
+     * entity.triggerModifiedEvent();
+     * ```
      */
     triggerModifiedEvent(): void;
+    /**
+     * Gets the line style for this entity.
+     *
+     * This method returns the line style based on the entity's linetype
+     * and other properties.
+     *
+     * @returns The line style object
+     *
+     * @example
+     * ```typescript
+     * const lineStyle = entity.lineStyle;
+     * ```
+     */
     protected get lineStyle(): AcGiLineStyle;
+    /**
+     * Gets the line type for this entity.
+     *
+     * This method resolves the line type, handling ByLayer and ByBlock
+     * references as needed.
+     *
+     * @returns The resolved line type name
+     *
+     * @example
+     * ```typescript
+     * const lineType = entity.getLineType();
+     * ```
+     */
     private getLineType;
+    /**
+     * Gets the color of the layer this entity belongs to.
+     *
+     * This method retrieves the color from the layer table for the
+     * layer this entity belongs to.
+     *
+     * @returns The layer color, or undefined if the layer doesn't exist
+     *
+     * @example
+     * ```typescript
+     * const layerColor = entity.getLayerColor();
+     * ```
+     */
     protected getLayerColor(): AcCmColor | null;
 }
 //# sourceMappingURL=AcDbEntity.d.ts.map

package/lib/entity/AcDbEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbEntity.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EACL,SAAS,EACT,YAAY,EACZ,WAAW,EACZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,UAAU,EACV,aAAa,EACb,YAAY,EACb,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAuC,MAAM,SAAS,CAAA;AAE5E,8BAAsB,UAAW,SAAQ,UAAU;IACjD,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,WAAW,CAAY;IAC/B,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,WAAW,CAAgB;IACnC,OAAO,CAAC,aAAa,CAAY;IAEjC,IAAI,IAAI,WAEP;IAED;;OAEG;IACH,IAAI,KAAK,IAGQ,MAAM,CADtB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAEtB;IAED;;OAEG;IACH,IAAI,KAAK,IAGQ,SAAS,CADzB;IACD,IAAI,KAAK,CAAC,KAAK,EAAE,SAAS,EAEzB;IAED;;;OAGG;IACH,IAAI,QAAQ,WAeX;IAED;;OAEG;IACH,IAAI,QAAQ,IAGQ,MAAM,CADzB;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;OAEG;IACH,IAAI,UAAU,IAGQ,MAAM,CAD3B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;OAIG;IACH,IAAI,aAAa,IAGQ,MAAM,CAD9B;IACD,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,EAE9B;IAED;;OAEG;IACH,IAAI,UAAU,IAGQ,OAAO,CAD5B;IACD,IAAI,UAAU,CAAC,KAAK,EAAE,OAAO,EAE5B;IAED;;OAEG;IACH,IAAI,YAAY,IAGQ,MAAM,CAD7B;IACD,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED;;;OAGG;IACH,gBAAgB;IAKhB;;;;;;;;;;;OAWG;IACH,iBAAiB,CAEf,SAAS,EAAE,aAAa,EAExB,eAAe,EAAE,MAAM,EAEvB,SAAS,EAAE,WAAW,EAEtB,SAAS,EAAE,WAAW,EAEtB,UAAU,EAAE,WAAW,EAAE;IAG3B;;;;OAIG;IAEH,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAIvC;;;;OAIG;IACH,QAAQ,KAAK,gBAAgB,IAAI,SAAS,CAAA;IAE1C;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,GAAG,UAAU,GAAG,SAAS;IAE7D;;OAEG;IACH,oBAAoB;IAOpB,SAAS,KAAK,SAAS,IAAI,aAAa,CAevC;IAED,OAAO,CAAC,WAAW;IAanB,SAAS,CAAC,aAAa;CAWxB"}
+{"version":3,"file":"AcDbEntity.d.ts","sourceRoot":"","sources":["../../src/entity/AcDbEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EACL,SAAS,EACT,YAAY,EACZ,WAAW,EACZ,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,UAAU,EACV,aAAa,EACb,YAAY,EACb,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAuC,MAAM,SAAS,CAAA;AAE5E;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,UAAW,SAAQ,UAAU;IACjD,4CAA4C;IAC5C,OAAO,CAAC,MAAM,CAAc;IAC5B,+BAA+B;IAC/B,OAAO,CAAC,MAAM,CAA6B;IAC3C,wCAAwC;IACxC,OAAO,CAAC,SAAS,CAAkB;IACnC,sCAAsC;IACtC,OAAO,CAAC,WAAW,CAAY;IAC/B,gDAAgD;IAChD,OAAO,CAAC,cAAc,CAAa;IACnC,qCAAqC;IACrC,OAAO,CAAC,WAAW,CAAgB;IACnC,kDAAkD;IAClD,OAAO,CAAC,aAAa,CAAY;IAEjC;;;;;;;;;;;;;OAaG;IACH,IAAI,IAAI,WAEP;IAED;;;;;;;;;OASG;IACH,IAAI,KAAK,IAcQ,MAAM,CAZtB;IAED;;;;;;;;;OASG;IACH,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAEtB;IAED;;;;;;;;;OASG;IACH,IAAI,KAAK,IAcQ,SAAS,CAZzB;IAED;;;;;;;;;OASG;IACH,IAAI,KAAK,CAAC,KAAK,EAAE,SAAS,EAEzB;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,QAAQ,WAeX;IAED;;;;;;;;;OASG;IACH,IAAI,QAAQ,IAcQ,MAAM,CAZzB;IAED;;;;;;;;;OASG;IACH,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU,IAcQ,MAAM,CAZ3B;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAE3B;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,aAAa,IAcQ,MAAM,CAZ9B;IAED;;;;;;;;;OASG;IACH,IAAI,aAAa,CAAC,KAAK,EAAE,MAAM,EAE9B;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU,IAcQ,OAAO,CAZ5B;IAED;;;;;;;;;OASG;IACH,IAAI,UAAU,CAAC,KAAK,EAAE,OAAO,EAE5B;IAED;;;;;;;;;OASG;IACH,IAAI,YAAY,IAcQ,MAAM,CAZ7B;IAED;;;;;;;;;OASG;IACH,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAE7B;IAED;;;;;;;;;;;;;OAaG;IACH,gBAAgB;IAKhB;;;;;;;;;;;;;;;;;;OAkBG;IACH,iBAAiB,CAEf,SAAS,EAAE,aAAa,EAExB,eAAe,EAAE,MAAM,EAEvB,SAAS,EAAE,WAAW,EAEtB,SAAS,EAAE,WAAW,EAEtB,UAAU,EAAE,WAAW,EAAE;IAG3B;;;;;;;;;;;;;;;OAeG;IAEH,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAIvC;;;;;;;;;;;;;OAaG;IACH,QAAQ,KAAK,gBAAgB,IAAI,SAAS,CAAA;IAE1C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,GAAG,UAAU,GAAG,SAAS;IAE7D;;;;;;;;;OASG;IACH,oBAAoB;IAOpB;;;;;;;;;;;;OAYG;IACH,SAAS,KAAK,SAAS,IAAI,aAAa,CAevC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,WAAW;IAanB;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,aAAa;CAWxB"}