@mlightcad/data-model/lib/entity/AcDbWipeout.d.ts

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.

import { AcGiRenderer } from '@mlightcad/graphic-interface';
import { AcDbRasterImage } from './AcDbRasterImage';
/**
 * Entity that creates a blank area in the drawing.
 *
 * The AcDbWipeout entity creates a blank area that covers other entities
 * in the drawing. It's commonly used to hide parts of the drawing or
 * create clean areas for annotations. The wipeout area is defined by
 * a boundary path and is rendered as a solid black fill.
 *
 * @example
 * ```typescript
 * const wipeout = new AcDbWipeout();
 * // Set up boundary path and other properties
 * wipeout.draw(renderer);
 * ```
 */
export declare class AcDbWipeout extends AcDbRasterImage {
    /** The entity type name */
    static typeName: string;
    /**
     * Draws the wipeout entity.
     *
     * This method creates a solid black area based on the boundary path
     * of the wipeout entity. The area covers all entities behind it,
     * effectively "wiping out" that portion of the drawing.
     *
     * @param renderer - The renderer to use for drawing
     * @returns The rendered entity or undefined if rendering fails
     *
     * @example
     * ```typescript
     * const wipeout = new AcDbWipeout();
     * const renderedEntity = wipeout.draw(renderer);
     * ```
     */
    draw(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity;
}
//# sourceMappingURL=AcDbWipeout.d.ts.map