@inweb/viewer-three/src/Viewer/models/IModelImpl.ts

JavaScript library for rendering CAD and BIM files in a browser using Three.js

///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a
//   license agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

import { Box3, Object3D } from "three";
import { IInfo, IModel } from "@inweb/viewer-core";

/**
 * Basic model implementation.
 */
export interface IModelImpl extends IModel {
  scene: Object3D;

  getUnits(): string;

  getUnitScale(): number;

  getUnitString(): string;

  getPrecision(): number;

  getInfo(): IInfo;

  getExtents(target: Box3): Box3;

  getObjects(): Object3D[];

  getVisibleObjects(): Object3D[];

  getObjectsByHandles(handles: string | string[]): Object3D[];

  getHandlesByObjects(objects: Object3D | Object3D[]): string[];

  hideObjects(objects: Object3D | Object3D[]): this;

  hideAllObjects(): this;

  isolateObjects(objects: Object3D | Object3D[]): this;

  showObjects(objects: Object3D | Object3D[]): this;

  showAllObjects(): this;

  highlightObjects(objects: Object3D | Object3D[]): this;

  unhighlightObjects(objects: Object3D | Object3D[]): this;

  explode(scale: number, coeff?: number): this;
}