import { Position } from '../Core';

/**
 * This interface is used as parameters of the {@link View~View.goToViewpoint | goToViewpoint } method.
 */
export interface ViewpointParameters {
    /**
     * Positions that the {@link View~View.goToViewpoint | goToViewpoint } method will make appear in the view.
     */
    readonly positions: Position[];
    /**
     * This parameter allows to specify the desired altitude that will be used to place the camera. The result from
     * {@link View~View.goToViewpoint | goToViewpoint } will take this altitude into account to ensure all the specified
     * positions are visible while the camera is placed at this altitude.
     * @defaultValue 0
     */
    readonly targetAltitude?: number;
}
