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

#ifndef _PRCFILESTRUCTURETESSELLATION_INCLUDED_
#define _PRCFILESTRUCTURETESSELLATION_INCLUDED_ 
 

#include "PrcUserData.h"
#include "PrcBase.h"
#include "PrcBaseTessData.h"

SMARTPTR(OdPrcFileStructureTessellation);

/** \details
A class that stores and handles tessellation data within the file structure.

<group PRC_Files_Structures_Assemblies>
*/
class PRC_TOOLKIT OdPrcFileStructureTessellation : public OdPrcBase
{
public:
  //DOM-IGNORE-BEGIN
  ODPRC_DECLARE_MEMBERS_PRCBASE(OdPrcFileStructureTessellation);
  //DOM-IGNORE-END

  /** \details 
  Requests the current tessellation data from the tessellation file structure.
  \returns An array of smart pointers to <link OdPrcBaseTessData, OdPrcBaseTessData> objects that contain the tessellation data.
  \remarks 
  The <link OdPrcBaseTessDataPtrArray, array of tessellation data> is returned via a reference, and therefore it can be used to set new tessellation data.
  To restrict modifications of the <link OdPrcBaseTessDataPtrArray, array of tessellation data> outside the <link OdPrcFileStructureTessellation, OdPrcFileStructureTessellation> object, 
  call another <link OdPrcFileStructureTessellation::tessellations@const, tessellations()> method that returns a constant reference.
  */
  OdPrcBaseTessDataPtrArray &tessellations();
  
  /** \details 
  Requests the current tessellation data from the tessellation file structure.
  \returns An array of smart pointers to <link OdPrcBaseTessData, OdPrcBaseTessData> objects that contain the tessellation data.
  */
  const OdPrcBaseTessDataPtrArray &tessellations() const;
  
  /** \details 
  Requests the current user-defined data from the tessellation file structure.
  \returns An <link OdPrcUserData, OdPrcUserData> object that contains the user-defined data.
  \remarks 
  User data is returned as a reference to an <link OdPrcUserData, OdPrcUserData> object, and therefore it can be used to set new user data.
  To restrict modifications of the user data outside the <link OdPrcFileStructureTessellation, OdPrcFileStructureTessellation> object, 
  call another <link OdPrcFileStructureGlobals::userData@const, userData()> method that returns a constant reference.
  */
  OdPrcUserData &userData();
  
  /** \details 
  Requests the current user-defined data from the tessellation file structure.
  \returns An <link OdPrcUserData, OdPrcUserData> object that contains the user-defined data.
  */
  const OdPrcUserData &userData() const;
};

#endif // _PRCFILESTRUCTURETESSELLATION_INCLUDED_