@mlightcad/graphic-interface/lib/AcGiViewport.d.ts

The graphic-interface package provides the graphics interface for controlling how AutoCAD entities are displayed on screen. This package offers a simplified API compared to AutoCAD ObjectARX's AcGi classes, making it more developer-friendly while maintain

import { AcGeBox2d, AcGePoint3d } from '@mlightcad/geometry-engine';
/**
 * This class ised used to pass back information to the user about the viewing characteristics of the
 * current viewport.
 */
export declare class AcGiViewport {
    private _centerPoint;
    private _height;
    private _width;
    private _viewCenter;
    private _viewHeight;
    private _number;
    private _id;
    private _groupId;
    constructor();
    /**
     * The viewport ID number. If the viewport is inactive, -1 is returned.
     */
    get number(): number;
    set number(value: number);
    /**
     * The id of the viewport.
     */
    get id(): string;
    set id(value: string);
    /**
     * The id of the group which this viewport belongs to.
     */
    get groupId(): string;
    set groupId(value: string);
    /**
     * The center point of the viewport entity in WCS coordinates (within Paper Space).
     */
    get centerPoint(): AcGePoint3d;
    set centerPoint(value: AcGePoint3d);
    /**
     * The height of the viewport entity's window in drawing units.
     */
    get height(): number;
    set height(value: number);
    /**
     * The width of the viewport entity's window in drawing units. This is the width in Paper Space
     * of the viewport itself, not the width of the Model Space view within the viewport.
     */
    get width(): number;
    set width(value: number);
    /**
     * The bounding box (in world coordinate system coordinates) of the viewport.
     */
    get box(): AcGeBox2d;
    /**
     * The view center (in display coordinate system coordinates) of the view in the viewport.
     */
    get viewCenter(): AcGePoint3d;
    set viewCenter(value: AcGePoint3d);
    /**
     * The height (in display coordinate system coordinates) of the Model Space view within the viewport.
     * Zooming the view out within the viewport increases this value and zooming in decreases this value.
     */
    get viewHeight(): number;
    set viewHeight(value: number);
    /**
     * The width (in display coordinate system coordinates) of the Model Space view within the viewport.
     * This is one computed property based on 'viewHeight' and viewport ratio of width and height.
     */
    get viewWidth(): number;
    /**
     * The bounding box (in display coordinate system coordinates) of the Model Space view within the viewport.
     */
    get viewBox(): AcGeBox2d;
    /**
     * Clone this viewport
     * @returns Return the cloned instance of this viewport
     */
    clone(): AcGiViewport;
    /**
     * Copy the property values of the passed viewport to this viewport.
     * @param viewport Input one viewport instance
     * @returns Return this viewport
     */
    copy(viewport: AcGiViewport): this;
}
//# sourceMappingURL=AcGiViewport.d.ts.map