DATAKIT SDK  V2026.4
dtk_proerReader.hpp
Go to the documentation of this file.
1 #ifndef _UTIL_PROER_READER_HPP_
2 #define _UTIL_PROER_READER_HPP_
3 
4 class ProeReader : public Dtk_Reader
5 {
6  //
7  class proerReader_Handle;
8  proerReader_Handle * _Private;
9 
10  static ProeReader * _ReaderInstance;
11 
12 
13  virtual ~ProeReader();
14  ProeReader();
15 
16 public:
17 
18  static ProeReader * GetInstance();
19  void Release();
20 
21  static Dtk_bool Enable();
22  proerReader_Handle* GetHandle() { return _Private; };
23  Dtk_ErrorStatus CreateDocument(const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument);
25 
26  Dtk_ErrorStatus GetFileVersion(const Dtk_string &inInputFile, Dtk_string& outVersion);
28  const Dtk_string& inInputFile,
29  Dtk_MainDocPtr& inoutDocument,
30  Dtk_ComponentPtr& outRootComponent);
31  Dtk_ErrorStatus PopulateComponentsTree(const Dtk_tab< Dtk_StreamPtr >& inArrayStream, Dtk_MainDocPtr& inoutDocument, Dtk_ComponentPtr& outRootComponent );
33 
35  const Dtk_ComponentPtr& inComponent,
36  Dtk_NodePtr& outRootNode);
37 
39 
43 
44  Dtk_ErrorStatus GetFilePreview( const Dtk_string & inInputFile, Dtk_PreviewPtr & outPreview );
45 
46 
52 
53 
54 
55  /*-----------------------------------------------------------------------------------------*/
56  //! [Options]
57  //! \brief Set the config to create or not conic on edge curves if possible
58  //! \param [in] inCreateConicEdge : DTK_TRUE [yes] , DTK_FALSE[no] default value DTK_FALSE
59  static void SetCreateConicEdges(const Dtk_bool inCreateConicEdges);
60  //! \brief Set the config to read only surfacic geometry (no solid)
61  //! \param [in] inSurfaciqueMode : DTK_TRUE [yes] , DTK_FALSE[no] default value DTK_FALSE
62  static void SetSurfaciqueMode(const Dtk_bool inSurfaciqueMode);
63  //! \brief Set the config to Use file swap instead memory (usefull for large files)
64  //! \param [in] inFileSwap : DTK_TRUE [yes] , DTK_FALSE[no] default value DTK_FALSE
65  static void SetFileSwapStatus(const Dtk_bool inFileSwap);
66  //! \brief Get the config to Use file swap
68  //! \brief Set the config to retreive detailled metadata (Designated, Access, Sources, etc..)
69  //! \param [in] inStatus : DTK_TRUE [yes] , DTK_FALSE[no] default value DTK_TRUE
70  static void GetDetailledMetadata( Dtk_bool inStatus );
71  //! \brief Set the config to retreive all metadata (including Unit or Mass Properties)
72  //! \param [in] inStatus : DTK_TRUE [yes] , DTK_FALSE[no] default value DTK_TRUE
73  static void GetAllMetadata( Dtk_bool inStatus );
74  //! \brief Set the config to retreive the final geometry of the component with assembly level feature (but only mesh or preview body)
75  //! \param [in] inStatus : DTK_TRUE [yes] , DTK_FALSE[no] default value DTK_FALSE
76  static void SetAssemblyLvlGeomConfig(const Dtk_bool inStatus);
77  //! \brief Set the config to disable projection on shaded 2D view (allowing you to shade body by yourself)
78  //! \param [in] inDisableProjection : DTK_TRUE [yes] , DTK_FALSE[no] default value DTK_FALSE
79  static void SetDisable2dProjectionForShadedView( const Dtk_bool inDisableProjection );
80  //! \brief Set the config to disable compute the hatching
81  //! \param [in] inDisableComputeHatching : DTK_TRUE [yes] , DTK_FALSE[no] default value DTK_FALSE
82  static void SetDisable2dComputeHatching( const Dtk_bool inDisableComputeHatching );
83  //! [Options]
84 
85 };
86 
87 
88 #endif
ProeReader::ActivateReader
Dtk_ErrorStatus ActivateReader()
ProeReader::EndPopulateComponentsTree
Dtk_ErrorStatus EndPopulateComponentsTree()
ProeReader::ReadComponentGraphic
Dtk_ErrorStatus ReadComponentGraphic(const Dtk_ComponentPtr &inComponent, Dtk_GraphicalDataPtr &outGraphicalData)
ProeReader::GetDetailledMetadata
static void GetDetailledMetadata(Dtk_bool inStatus)
Set the config to retreive detailled metadata (Designated, Access, Sources, etc..)
ProeReader::ReadComponent
Dtk_ErrorStatus ReadComponent(const Dtk_ComponentPtr &inComponent, Dtk_NodePtr &outRootNode)
Dtk_Reader
Definition: dtk_reader.hpp:15
ProeReader::GetConnectorsPointingToThisComponent
Dtk_ErrorStatus GetConnectorsPointingToThisComponent(Dtk_Component &inCompo, Dtk_tab< Dtk_NodeConnectorPtr > &outConnectedEntities)
ProeReader::GetAssociatedEntities
Dtk_ErrorStatus GetAssociatedEntities(Dtk_Node &inNode, Dtk_tab< Dtk_NodeConnectorPtr > &outAssociatedEntities)
ProeReader::Release
void Release()
ProeReader::GetHandle
proerReader_Handle * GetHandle()
Definition: dtk_proerReader.hpp:22
Dtk_string
This is a high level string class.
Definition: dtk_string.hpp:53
ProeReader::SetCreateConicEdges
static void SetCreateConicEdges(const Dtk_bool inCreateConicEdges)
Set the config to create or not conic on edge curves if possible.
ProeReader::GetFileSwapStatus
static Dtk_bool GetFileSwapStatus()
Get the config to Use file swap.
ProeReader::SetAssemblyLvlGeomConfig
static void SetAssemblyLvlGeomConfig(const Dtk_bool inStatus)
Set the config to retreive the final geometry of the component with assembly level feature (but only ...
Dtk_bool
char Dtk_bool
Definition: define.h:724
ProeReader::PopulateComponentsTree
Dtk_ErrorStatus PopulateComponentsTree(const Dtk_tab< Dtk_StreamPtr > &inArrayStream, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)
ProeReader::Enable
static Dtk_bool Enable()
ProeReader
Definition: dtk_proerReader.hpp:5
ProeReader::EndComponent
Dtk_ErrorStatus EndComponent(Dtk_ComponentPtr &inComponent)
ProeReader::GetVersion
Dtk_Int32 GetVersion()
ProeReader::GetAllMetadata
static void GetAllMetadata(Dtk_bool inStatus)
Set the config to retreive all metadata (including Unit or Mass Properties)
Dtk_Node
This is the Node Class.
Definition: dtk_maindoc.hpp:234
Dtk_Int32
int32_t Dtk_Int32
Definition: define.h:686
ProeReader::DesactivateReader
Dtk_ErrorStatus DesactivateReader()
ProeReader::SetDisable2dProjectionForShadedView
static void SetDisable2dProjectionForShadedView(const Dtk_bool inDisableProjection)
Set the config to disable projection on shaded 2D view (allowing you to shade body by yourself)
Dtk_ErrorStatus
Dtk_ErrorStatus
Definition: error_dtk.hpp:6
ProeReader::SetFileSwapStatus
static void SetFileSwapStatus(const Dtk_bool inFileSwap)
Set the config to Use file swap instead memory (usefull for large files)
Dtk_SmartPtr
Definition: util_ptr_dtk.hpp:37
ProeReader::ReadAdditionalInfos
Dtk_ErrorStatus ReadAdditionalInfos(Dtk_Node &inNode, Dtk_ObjectPtr &outEntity)
ProeReader::SetDisable2dComputeHatching
static void SetDisable2dComputeHatching(const Dtk_bool inDisableComputeHatching)
Set the config to disable compute the hatching.
ProeReader::GetFileVersion
Dtk_ErrorStatus GetFileVersion(const Dtk_string &inInputFile, Dtk_string &outVersion)
ProeReader::ReadEntity
Dtk_ErrorStatus ReadEntity(Dtk_Node &inNode, Dtk_EntityPtr &outEntity)
ProeReader::PopulateComponentsTree
Dtk_ErrorStatus PopulateComponentsTree(const Dtk_string &inInputFile, Dtk_MainDocPtr &inoutDocument, Dtk_ComponentPtr &outRootComponent)
ProeReader::GetInstance
static ProeReader * GetInstance()
Dtk_tab
This is a high level array class.
Definition: util_stl_dtk.hpp:84
ProeReader::GetFilePreview
Dtk_ErrorStatus GetFilePreview(const Dtk_string &inInputFile, Dtk_PreviewPtr &outPreview)
ProeReader::SetSurfaciqueMode
static void SetSurfaciqueMode(const Dtk_bool inSurfaciqueMode)
Set the config to read only surfacic geometry (no solid)
Dtk_Component
This is the Component Class. The Dtk_ComponentPtr object is used as element into an assembly tree....
Definition: dtk_maindoc.hpp:558
ProeReader::CreateDocument
Dtk_ErrorStatus CreateDocument(const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
ProeReader::CreateDocumentGraphical
Dtk_ErrorStatus CreateDocumentGraphical(const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)