dtk_proerReader.hpp

Go to the documentation of this file.

#ifndef _UTIL_PROER_READER_HPP_
#define _UTIL_PROER_READER_HPP_
 
 
//! \deprecated  Use static ProeReader::SetFileSwap
SetAsDeprecated("2022.2", "Use ProeReader::SetFileSwap method instead.")
void proer_allowFileSwap_Deprecated222();
//! \deprecated  Use static ProeReader::GetFileSwap
SetAsDeprecated("2022.2", "Use ProeReader::GetFileSwap method instead.")
Dtk_bool proer_GetFileSwapStatus_Deprecated222();
//! \deprecated  Use static ProeReader::SetCreateConicEdges
SetAsDeprecated("2022.2", "Use ProeReader::SetCreateConicEdges method instead.")
void proer_SetCreateConicEdges_Deprecated222( const Dtk_bool  inCreateConicEdges );
//! \deprecated  Use static ProeReader::SetSurfaciqueMode
SetAsDeprecated("2022.2", "Use ProeReader::SetSurfaciqueMode method instead.")
void proer_SetSurfaciqueMode_Deprecated222( const Dtk_bool  inSurfaciqueMode );
 
class ProeReader : public Dtk_Reader
{
     //
     class proerReader_Handle;
     proerReader_Handle * _Private;
 
     static ProeReader * _ReaderInstance;
 
 
     virtual ~ProeReader();
     ProeReader();
 
public:
 
     static ProeReader * GetInstance();
     void Release();
     
     static Dtk_bool Enable();
     proerReader_Handle* GetHandle() { return _Private; };
     Dtk_ErrorStatus CreateDocument(const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument);
     Dtk_ErrorStatus CreateDocumentGraphical( const Dtk_string &inInputFile, Dtk_MainDocPtr& outDocument );
 
     Dtk_ErrorStatus GetFileVersion(const Dtk_string &inInputFile, Dtk_string& outVersion);
     Dtk_ErrorStatus PopulateComponentsTree(
          const Dtk_string& inInputFile,
          Dtk_MainDocPtr& inoutDocument,
          Dtk_ComponentPtr& outRootComponent);
     Dtk_ErrorStatus PopulateComponentsTree(const Dtk_tab< Dtk_StreamPtr >& inArrayStream, Dtk_MainDocPtr& inoutDocument, Dtk_ComponentPtr& outRootComponent );
     Dtk_ErrorStatus EndPopulateComponentsTree();
 
     Dtk_ErrorStatus ReadComponent(
          const Dtk_ComponentPtr& inComponent, 
          Dtk_NodePtr& outRootNode);
 
     Dtk_ErrorStatus ReadComponentGraphic( const Dtk_ComponentPtr &inComponent, Dtk_GraphicalDataPtr& outGraphicalData );
 
     Dtk_ErrorStatus ReadEntity(Dtk_Node & inNode, Dtk_EntityPtr& outEntity);
     Dtk_ErrorStatus ReadAdditionalInfos(Dtk_Node & inNode, Dtk_ObjectPtr &outEntity);
     Dtk_Int32 GetVersion();
 
     Dtk_ErrorStatus GetFilePreview( const Dtk_string & inInputFile, Dtk_PreviewPtr & outPreview );
 
 
     Dtk_ErrorStatus EndComponent( Dtk_ComponentPtr& inComponent );
     Dtk_ErrorStatus ActivateReader();
     Dtk_ErrorStatus DesactivateReader();
     Dtk_ErrorStatus GetConnectorsPointingToThisComponent(Dtk_Component& inCompo,Dtk_tab<Dtk_NodeConnectorPtr> &outConnectedEntities);
     Dtk_ErrorStatus GetAssociatedEntities(Dtk_Node& inNode, Dtk_tab< Dtk_NodeConnectorPtr > &outAssociatedEntities);
 
 
 
     /*-----------------------------------------------------------------------------------------*/
     //! [Options] 
     //! \brief Set the config to create or not conic on edge curves if possible
     //! \param [in] inCreateConicEdge : DTK_TRUE [yes] , DTK_FALSE[no]  default value DTK_FALSE
     static void SetCreateConicEdges(const Dtk_bool  inCreateConicEdges);
     //! \brief Set the config to read only surfacic geometry (no solid)
     //! \param [in] inSurfaciqueMode : DTK_TRUE [yes] , DTK_FALSE[no]  default value DTK_FALSE
     static void SetSurfaciqueMode(const Dtk_bool  inSurfaciqueMode);
     //! \brief Set the config to Use file swap instead memory (usefull for large files)
     //! \param [in] inFileSwap : DTK_TRUE [yes] , DTK_FALSE[no]  default value DTK_FALSE
     static void SetFileSwapStatus(const Dtk_bool  inFileSwap);
     //! \brief Get the config to Use file swap 
     static Dtk_bool GetFileSwapStatus();
     //! \brief Set the config to retreive detailled metadata (Designated, Access, Sources, etc..)
     //! \param [in] inStatus : DTK_TRUE [yes] , DTK_FALSE[no]  default value DTK_TRUE
     static void GetDetailledMetadata( Dtk_bool inStatus );
     //! \brief Set the config to retreive all metadata (including Unit or Mass Properties)
     //! \param [in] inStatus : DTK_TRUE [yes] , DTK_FALSE[no]  default value DTK_TRUE
     static void GetAllMetadata( Dtk_bool inStatus );
     //! \brief Set the config to retreive the final geometry of the component with assembly level feature (but only mesh or preview body)
     //! \param [in] inStatus : DTK_TRUE [yes] , DTK_FALSE[no]  default value DTK_FALSE
     static void SetAssemblyLvlGeomConfig(const Dtk_bool inStatus);
     //! \brief Set the config to disable projection on shaded 2D view (allowing you to shade body by yourself)
     //! \param [in] inDisableProjection : DTK_TRUE [yes] , DTK_FALSE[no]  default value DTK_FALSE
     static void SetDisable2dProjectionForShadedView( const Dtk_bool  inDisableProjection );
     //! \brief Set the config to disable compute the hatching
     //! \param [in] inDisableComputeHatching : DTK_TRUE [yes] , DTK_FALSE[no]  default value DTK_FALSE
     static void SetDisable2dComputeHatching( const Dtk_bool  inDisableComputeHatching );
     //! [Options] 
 
};
 
 
#endif