@inweb/client/src/Api/IAssembly.ts

JavaScript REST API client for the Open Cloud Server

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

/**
 * Defines the information about file from which the assembly was created.
 */
export interface IAssociatedFileData {
  /**
   * File ID.
   */
  fileId: string;

  /**
   * File name.
   */
  name: string;

  link: string;
  version?: number;
}

export interface IAssemblyVersionInfo {
  assemblyId: string;
  status: string;
  version: number;
  createdAt: string;
  ownerId: string;
}

/**
 * Model transformation matrix.
 */
export interface IModelTransformMatrix {
  /**
   * Translation part, move by specified offset along the X, Y, Z axes.
   */
  translate: {
    x: number;
    y: number;
    z: number;
  };
  /**
   * Rotation part, rotate by the specified angle, around the specified vector.
   */
  rotation: {
    x: number;
    y: number;
    z: number;
    angle: number;
  };
  /**
   * Scaling part, scale with multiplier, from center of extends.
   */
  scale: number;
}

/**
 * Defines the information about the clash of two objects.
 */
export interface IClashItem {
  /**
   * Handle of the first object, including the assembly model index in the form "model_object".
   */
  first: string;

  /**
   * Handle of the second object, including the assembly model index in the form "model_object".
   */
  second: string;

  /**
   * The distance between objects.
   */
  distance: number;
}