/////////////////////////////////////////////////////////////////////////////// 
// 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 _IFC_GEOM_MODULE_H_
#define _IFC_GEOM_MODULE_H_

#include "OdPlatformSettings.h"
#include "ModuleNames.h"
#include "RxDynamicModule.h"

#include "IfcEntityTypes.h"

#include "TD_PackPush.h"

class OdIfcEntResolver;

/** \details 
Contains declarations related to working with IFC files content.
*/
namespace OdIfc {

/** \details 
A class that implements a module for working with IFC geometry. 
*/
class OdIfcGeomModule : public OdRxModule
{
public:

  /** \details 
  Initializes the IFC geometry module.
  */
  virtual void      initApp() = 0;
  
  /** \details 
  De-initializes the IFC geometry module.
  */
  virtual void      uninitApp() = 0;

  /** \details 
  Retrieves the current entity resolver object assigned to the module.
  \returns Returns a raw pointer to the entity resolver object.
  */
  virtual OdIfcEntResolver* getIfcEntResolver() = 0;

  /** \details
  Registers an external OdIfc::OdIfcCompound class for geometry compose.
  \param entityType [in] An IFC entity type to associate ifcCompoundClass with.
  \param ifcCompoundClass [in] An instance of OdRxClass for OdIfc::OdIfcCompound implementation.
  \returns True if registered successfully; otherwise the method returns false.
  */
  virtual bool registerExternalCompound(OdIfc::OdIfcEntityType entityType, OdRxClass *ifcCompoundClass) = 0;

  /** \details
  Unregisters an external OdIfc::OdIfcCompound class from IFC geometry module.
  \param entityType [in] An IFC entity type with whom ifcCompoundClass is associated.
  \param ifcCompoundClass [in] An instance of OdRxClass to unregister.
  \returns True if unregistered successfully; otherwise the method returns false.
  */
  virtual bool unregisterExternalCompound(OdIfc::OdIfcEntityType entityType, OdRxClass *ifcCompoundClass) = 0;

};

/** \details 
A data type that represents a smart pointer to an <exref target="../tifc_api_cpp/OdIfc__OdIfcGeomModule.html">OdIfcGeomModule</exref> object.
*/
typedef OdSmartPtr<OdIfcGeomModule> OdIfcGeomModulePtr;

}

/** \details
Retrieves currently initialized geometrical module for IFC SDK geometry compose and visualization.
\returns Returns a smart pointer to the currently initialized geometry module for IFC SDK.
*/
IFCCORE_EXPORT OdIfc::OdIfcGeomModulePtr odIfcGeomModule();

#include "TD_PackPop.h"

#endif // _IFC_GEOM_MODULE_H_