@inweb/viewer-core/src/models/IModel.ts

3D CAD and BIM data Viewer core

///////////////////////////////////////////////////////////////////////////////
// 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.
///////////////////////////////////////////////////////////////////////////////

/**
 * Model interface.
 */
export interface IModel {
  /**
   * Unique model ID, used as a model prefix when selecting objects in assemblies (multi-model scenes).
   * Can be:
   *
   * - `file ID` - when loading a file from Open Cloud Server.
   * - `assembly ID` - when loading an assembly from Open Cloud Server.
   * - `model ID` - when loading a model of the file/assembly from Open Cloud Server.
   * - `file name` - when loading from local File or URL.
   * - `user defined` - when loading from ArrayBuffer or Data URL.
   */
  id: string;

  /**
   * Disposes the model and releases allocated resources.
   */
  dispose(): void;
}