@itwin/core-frontend/lib/cjs/StandardView.d.ts

iTwin.js frontend components

/** @packageDocumentation
 * @module Views
 */
import { Matrix3d } from "@itwin/core-geometry";
/** Describes a set of commonly-used view rotations.
 * @public
 * @extensions
 */
export declare enum StandardViewId {
    /** Any rotation which does not match one of the standard rotations.
     * Invalid as an argument to StandardView.getStandardRotation() - used as a return value only.
     */
    NotStandard = -1,
    Top = 0,
    Bottom = 1,
    Left = 2,
    Right = 3,
    Front = 4,
    Back = 5,
    Iso = 6,
    RightIso = 7
}
/** Supplies access to a set of commonly-used view rotations.
 * @public
 */
export declare class StandardView {
    static get top(): Matrix3d;
    static get bottom(): Matrix3d;
    static get left(): Matrix3d;
    static get right(): Matrix3d;
    static get front(): Matrix3d;
    static get back(): Matrix3d;
    static get iso(): Matrix3d;
    static get rightIso(): Matrix3d;
    /** Obtain a [[Matrix3d]] corresponding to the specified [[StandardViewId]].
     * @param id The ID of the desired rotation.
     * @return A rotation matrix corresponding to the requested standard view ID, or a "top" view rotation if the input does not correspond to a standard rotation.
     */
    static getStandardRotation(id: StandardViewId): Matrix3d;
    /** Attempts to adjust the supplied rotation matrix to match the standard view rotation it most closely matches.
     * If a matching standard rotation exists, the input matrix will be modified in-place to precisely match it.
     * Otherwise, the input matrix will be unmodified.
     * @param matrix The rotation matrix to adjust.
     */
    static adjustToStandardRotation(matrix: Matrix3d): void;
}
//# sourceMappingURL=StandardView.d.ts.map