@mlightcad/data-model/lib/entity/AcDbFace.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 { AcGeBox3d, AcGePoint3d, AcGePointLike } from '@mlightcad/geometry-engine';
import { AcGiRenderer } from '@mlightcad/graphic-interface';
import { AcDbEntity } from './AcDbEntity';
/**
 * Represents a three-dimensional surface patch — specifically, a flat polygon that
 * can have three or four vertices (triangular or quadrilateral). It’s one of the
 * simplest types of 3D geometry in AutoCAD — used mainly for visual representation
 * of 3D models, not for solid modeling.
 */
export declare class AcDbFace extends AcDbEntity {
    /** The entity type name */
    static typeName: string;
    /** The three or four vertices of the face */
    private _vertices;
    /** The invisibility of the edges of the face */
    private _edgeInvisibilities;
    /**
     * Creates a new face entity.
     *
     * This constructor initializes a face with default values.
     * All vertices are set to the origin.
     */
    constructor();
    /**
     * Gets the point at the specified index in this face.
     *
     * The index can be 0, 1, 2, or 3, representing the four vertices of the face.
     * If the index is out of range, it returns the first or last vertex accordingly.
     *
     * @param index - The index (0-3) of the vertex to get
     * @returns The point at the specified index in WCS coordinates
     *
     * @example
     * ```typescript
     * const point0 = face.getVertexAt(0);
     * const point1 = face.getVertexAt(1);
     * console.log(`Vertex 0: ${point0.x}, ${point0.y}, ${point0.z}`);
     * ```
     */
    getVertexAt(index: number): AcGePoint3d;
    /**
     * Sets the point at the specified index in this face.
     *
     * The index must be 0, 1, 2, or 3, representing the four vertices of the face.
     * If the index is out of range, it sets the first or last vertex accordingly.
     *
     * @param index - The index (0-3) of the vertex to set
     * @param point - The new point in WCS coordinates
     *
     * @example
     * ```typescript
     * face.setVertexAt(0, new AcGePoint3d(0, 0, 0));
     * face.setVertexAt(1, new AcGePoint3d(10, 0, 0));
     * face.setVertexAt(2, new AcGePoint3d(10, 5, 0));
     * face.setVertexAt(3, new AcGePoint3d(0, 5, 0));
     * ```
     */
    setVertexAt(index: number, point: AcGePointLike): AcGePoint3d | undefined;
    /**
     * Sets the invisibilities of the edges of the face.
     *
     * The invisibilities are represented as a bitmask, where each bit corresponds to an edge.
     * If the bit is set, the edge is invisible, otherwise it is visible.
     *
     * @param invisibilities - The bitmask representing the invisibilities of the edges
     *
     * @example
     * ```typescript
     * face.setEdgeInvisibilities(0b1111); // All edges are visible
     * face.setEdgeInvisibilities(0b0000); // All edges are invisible
     * face.setEdgeInvisibilities(0b1010); // Edge 0 and 2 are visible, edge 1 and 3 are invisible
     * ```
     */
    setEdgeInvisibilities(invisibilities: number): void;
    /**
     * Checks if the edge at the specified index is visible.
     *
     * The index must be 0, 1, 2, or 3, representing the four edges of the face.
     * If the index is out of range, it throws an error.
     *
     * @param index - The index (0-3) of the edge to check
     * @returns True if the edge is visible, false otherwise
     *
     * @example
     * ```typescript
     * const isVisible = face.isEdgeVisibleAt(0);
     * console.log(`Edge 0 is visible: ${isVisible}`);
     * ```
     */
    isEdgeVisibleAt(index: number): boolean;
    /**
     * Makes the edge at the specified index invisible.
     *
     * The index must be 0, 1, 2, or 3, representing the four edges of the face.
     * If the index is out of range, it throws an error.
     *
     * @param index - The index (0-3) of the edge to make invisible
     *
     * @example
     * ```typescript
     * face.makeEdgeInvisibleAt(0);
     * face.makeEdgeInvisibleAt(1);
     * face.makeEdgeInvisibleAt(2);
     * face.makeEdgeInvisibleAt(3);
     * ```
     */
    makeEdgeInvisibleAt(index: number): void;
    /**
     * Gets the geometric extents (bounding box) of this face.
     *
     * @returns The bounding box that encompasses the entire face
     *
     * @example
     * ```typescript
     * const extents = face.geometricExtents;
     * console.log(`Trace bounds: ${extents.minPoint} to ${extents.maxPoint}`);
     * ```
     */
    get geometricExtents(): AcGeBox3d;
    /**
     * Gets the grip points for this face.
     *
     * Grip points are control points that can be used to modify the face.
     * For a face, the grip points are all four vertices.
     *
     * @returns Array of grip points (all four vertices)
     *
     * @example
     * ```typescript
     * const gripPoints = face.subGetGripPoints();
     * // gripPoints contains all four vertices of the face
     * ```
     */
    subGetGripPoints(): AcGePoint3d[];
    /**
     * Draws this face using the specified renderer.
     *
     * This method renders the face as a filled area using the face's
     * current style properties.
     *
     * @param renderer - The renderer to use for drawing
     * @returns The rendered face entity, or undefined if drawing failed
     *
     * @example
     * ```typescript
     * const renderedFace = face.draw(renderer);
     * ```
     */
    draw(renderer: AcGiRenderer): import("@mlightcad/graphic-interface").AcGiEntity;
}
//# sourceMappingURL=AcDbFace.d.ts.map