@mlightcad/data-model
Version:
The data-model package provides the core classes for interacting with AutoCAD's database and entities. This package mimics AutoCAD ObjectARX's AcDb (Database) classes and implements the drawing database structure that AutoCAD developers are familiar with.
201 lines • 7.01 kB
TypeScript
import { AcGeBox3d, AcGePoint3d, AcGeVector3d, AcGeVector3dLike } from '@mlightcad/geometry-engine';
import { AcGiEntity, AcGiRenderer } from '@mlightcad/graphic-interface';
import { AcDbEntity } from './AcDbEntity';
import { AcDbEntityProperties } from './AcDbEntityProperties';
/**
* Represents a block reference entity in AutoCAD.
*
* A block reference is used to place, size, and display an instance of the collection
* of entities within the block table record that it references. Block references allow
* you to reuse complex geometry by referencing a block definition multiple times with
* different positions, rotations, and scales.
*
* @example
* ```typescript
* // Create a block reference
* const blockRef = new AcDbBlockReference("MyBlock");
* blockRef.position = new AcGePoint3d(10, 20, 0);
* blockRef.rotation = Math.PI / 4; // 45 degrees
* blockRef.scaleFactors = new AcGePoint3d(2, 2, 1); // 2x scale
*
* // Access block reference properties
* console.log(`Block name: ${blockRef.blockTableRecord?.name}`);
* console.log(`Position: ${blockRef.position}`);
* console.log(`Rotation: ${blockRef.rotation}`);
* ```
*/
export declare class AcDbBlockReference extends AcDbEntity {
/** The entity type name */
static typeName: string;
/** The WCS position point (insertion point) of the block reference */
private _position;
/** The rotation value in radians */
private _rotation;
/** The X, Y, and Z scale factors for the block reference */
private _scaleFactors;
/** The normal vector of the plane containing the block reference */
private _normal;
/** The name of the referenced block */
private _blockName;
/**
* Creates a new block reference entity.
*
* This constructor initializes a block reference with the specified block name.
* The position is set to the origin, rotation to 0, normal to Z-axis, and scale factors to 1.
*
* @param blockName - The name of the block table record to reference
*
* @example
* ```typescript
* const blockRef = new AcDbBlockReference("MyBlock");
* blockRef.position = new AcGePoint3d(5, 10, 0);
* blockRef.rotation = Math.PI / 6; // 30 degrees
* ```
*/
constructor(blockName: string);
/**
* Gets the WCS position point (insertion point) of the block reference.
*
* @returns The position point in WCS coordinates
*
* @example
* ```typescript
* const position = blockRef.position;
* console.log(`Block position: ${position.x}, ${position.y}, ${position.z}`);
* ```
*/
get position(): AcGePoint3d;
/**
* Sets the WCS position point (insertion point) of the block reference.
*
* @param value - The new position point
*
* @example
* ```typescript
* blockRef.position = new AcGePoint3d(15, 25, 0);
* ```
*/
set position(value: AcGePoint3d);
/**
* Gets the rotation value of the block reference.
*
* The rotation value is relative to the X axis of a coordinate system that is parallel
* to the OCS of the block reference, but has its origin at the position point of the
* block reference. The rotation axis is the Z axis of this coordinate system with
* positive rotations going counterclockwise when looking down the Z axis towards the origin.
*
* @returns The rotation value in radians
*
* @example
* ```typescript
* const rotation = blockRef.rotation;
* console.log(`Rotation: ${rotation} radians (${rotation * 180 / Math.PI} degrees)`);
* ```
*/
get rotation(): number;
/**
* Sets the rotation value of the block reference.
*
* @param value - The new rotation value in radians
*
* @example
* ```typescript
* blockRef.rotation = Math.PI / 4; // 45 degrees
* ```
*/
set rotation(value: number);
/**
* Gets the X, Y, and Z scale factors for the block reference.
*
* @returns The scale factors as a 3D point
*
* @example
* ```typescript
* const scaleFactors = blockRef.scaleFactors;
* console.log(`Scale factors: ${scaleFactors.x}, ${scaleFactors.y}, ${scaleFactors.z}`);
* ```
*/
get scaleFactors(): AcGePoint3d;
/**
* Sets the X, Y, and Z scale factors for the block reference.
*
* @param value - The new scale factors
*
* @example
* ```typescript
* blockRef.scaleFactors = new AcGePoint3d(2, 1.5, 1); // 2x X scale, 1.5x Y scale
* ```
*/
set scaleFactors(value: AcGePoint3d);
/**
* Gets the normal vector of the plane containing the block reference.
*
* @returns The normal vector
*
* @example
* ```typescript
* const normal = blockRef.normal;
* console.log(`Normal: ${normal.x}, ${normal.y}, ${normal.z}`);
* ```
*/
get normal(): AcGeVector3d;
/**
* Sets the normal vector of the plane containing the block reference.
*
* @param value - The new normal vector
*
* @example
* ```typescript
* blockRef.normal = new AcGeVector3d(0, 0, 1);
* ```
*/
set normal(value: AcGeVector3dLike);
/**
* Gets the block table record referenced by this block reference.
*
* The referenced block table record contains the entities that the block reference will display.
*
* @returns The block table record, or undefined if not found
*
* @example
* ```typescript
* const blockRecord = blockRef.blockTableRecord;
* if (blockRecord) {
* console.log(`Block name: ${blockRecord.name}`);
* }
* ```
*/
get blockTableRecord(): import("..").AcDbBlockTableRecord | undefined;
/**
* Returns the full property definition for this block reference entity, including
* general group and geometry group.
*
* The geometry group exposes editable properties via {@link AcDbPropertyAccessor}
* so the property palette can update the block reference in real-time.
*
* Each property is an {@link AcDbEntityRuntimeProperty}.
*/
get properties(): AcDbEntityProperties;
/**
* Gets the geometric extents (bounding box) of this block reference.
*
* This method calculates the bounding box by transforming the geometric extents
* of all entities in the referenced block according to the block reference's
* position, rotation, and scale factors.
*
* @returns The bounding box that encompasses the entire block reference
*
* @example
* ```typescript
* const extents = blockRef.geometricExtents;
* console.log(`Block bounds: ${extents.minPoint} to ${extents.maxPoint}`);
* ```
*/
get geometricExtents(): AcGeBox3d;
/**
* @inheritdoc
*/
draw(renderer: AcGiRenderer): AcGiEntity | undefined;
private computeTransformMatrix;
}
//# sourceMappingURL=AcDbBlockReference.d.ts.map