INavigation

INavigation – интерфейс, позволяющий взаимодействовать с навигацией на сцене.

export interface INavigation {
  registerNavigation(navigationTool: INavigationTool): void;
  unregisterNavigation(navigationTool: INavigationTool): void;
  setActive(navigationToolName: string, isActive: boolean): void;
  getActiveNavigation(): INavigationTool | null;
  getNavigationAgent(): INavigationAgent;
  getNavigationArea(): DOMRect;
  setCameraParameters(params: CameraParameters): void;
  getCameraParameters(): CameraParameters;
  getCameraControl(): ICameraControl;
  fitToView(elementIds: string[] | string | ModelElementIds[], modelPart?: string | ModelPart, immediate?: boolean, cameraOrientation?: CameraOrientation): void;
  setPivotPoint(point: Point3): void;
  getPivotPoint(): Point3;
  resetPivotPoint(): void;
}

Методы

registerNavigation()

Метод позволяет зарегистрировать обработчик событий навигации.

registerNavigation(navigationTool: INavigationTool): void;

где:
navigationTool – реализация обработчика событий. Подробнее: INavigationTool.

unregisterNavigation()

Метод позволяет разрегистрировать обработчик событий навигации.

unregisterNavigation(navigationTool: INavigationTool): void;

где:
navigationTool – реализация обработчика событий. Подробнее: INavigationTool.

setActive()

Метод позволяет активировать обработчик событий навигации. Активным может быть только один обработчик навигации в каждый момент времени.

setActive(navigationToolName: string, isActive: boolean): void;

где:
navigationToolName – имя обработчика навигации,
isActive – активность.

getActiveNavigation()

Метод позволяет получить текущий обработчик навигации.

getActiveNavigation(): INavigationTool | null;

Возвращает объект INavigationTool.

getNavigationAgent()

Метод позволяет получить INavigationAgent - предоставляющий источники событий навигации.

getNavigationAgent(): INavigationAgent;

Возвращает объект INavigationAgent.

getNavigationArea()

Метод позволяет получить прямоугольник области навигации.

  getNavigationArea(): DOMRect;

Возвращает объект DOMRect.

setCameraParameters()

Метод позволяет установить параметры камеры.

setCameraParameters(params: CameraParameters): void;

где:
params – параметры камеры. Подробнее: CameraParameters.

getCameraParameters()

Метод позволяет получить параметры камеры.

getCameraParameters(): CameraParameters;

Возвращает параметры камеры. Подробнее: CameraParameters.

getCameraControl()

Метод позволяет получить контроллер камеры.

  getCameraControl(): ICameraControl;

Возвращает контроллер камеры. Подробнее: ICameraControl.

fitToView()

Метод позволяет спозиционировать заданные элементы в центре экрана.

fitToView(elementIds: string[] | string | ModelElementIds[], modelPart?: string | ModelPart, immediate?: boolean, cameraOrientation?: CameraOrientation): void;

где:
elementIds – список идентификаторов или один идентификатор элемента сцены,
modelPart – идентификатор части консолидированной модели или объект части консолидированной модели,
immediate – анимация при центрировании, true – отключить анимацию, false – включить анимацию. По умолчанию анимация включена.
cameraOrientation – конечная ориентация камеры. По умолчанию сохраняется текущая ориентация камеры. Подробнее: CameraOrientation.

setPivotPoint()

Метод позволяет задать положение опорной точки камеры.

setPivotPoint(point: Point3): void;

где:
point – точка в пространстве сцены. Подробнее: Point3.

getPivotPoint()

Метод позволяет получить положение опорной точки камеры.

getPivotPoint(): Point3;

Возвращает объект типа Point3.

resetPivotPoint()

Метод позволяет сбросить положение опорной точки камеры.

resetPivotPoint(): void;