DATAKIT API  V2025.1
dtk_proerReader.hpp
Go to the documentation of this file.
1 #ifndef _UTIL_PROER_READER_HPP_
2 #define _UTIL_PROER_READER_HPP_
3 
4 
6 SetAsDeprecated("2022.2", "Use ProeReader::SetFileSwap method instead.")
7 void proer_allowFileSwap();
9 SetAsDeprecated("2022.2", "Use ProeReader::GetFileSwap method instead.")
10 Dtk_bool proer_GetFileSwapStatus();
12 SetAsDeprecated("2022.2", "Use ProeReader::SetCreateConicEdges method instead.")
13 void proer_SetCreateConicEdges( const Dtk_bool inCreateConicEdges );
15 SetAsDeprecated("2022.2", "Use ProeReader::SetSurfaciqueMode method instead.")
16 void proer_SetSurfaciqueMode( const Dtk_bool inSurfaciqueMode );
17 
18 class ProeReader : public Dtk_Reader
19 {
20  //
21  class proerReader_Handle;
22  proerReader_Handle * _Private;
23 
24  static ProeReader * _ReaderInstance;
25 
26 
27  virtual ~ProeReader();
28  ProeReader();
29 
30 public:
31 
32  static ProeReader * GetInstance();
33  void Release();
34 
35  static Dtk_bool Enable();
36 
37  Dtk_ErrorStatus CreateDocument(const Dtk_string& inInputFile, Dtk_MainDocPtr& outDocument);
39 
40  Dtk_ErrorStatus GetFileVersion(const Dtk_string &inInputFile, Dtk_string& outVersion);
42  const Dtk_string& inInputFile,
43  Dtk_MainDocPtr& inoutDocument,
44  Dtk_ComponentPtr& outRootComponent);
45  Dtk_ErrorStatus PopulateComponentsTree(const Dtk_tab< Dtk_StreamPtr >& inArrayStream, Dtk_MainDocPtr& inoutDocument, Dtk_ComponentPtr& outRootComponent );
47 
49  const Dtk_ComponentPtr& inComponent,
50  Dtk_NodePtr& outRootNode);
51 
53 
57 
58  Dtk_ErrorStatus GetFilePreview( const Dtk_string & inInputFile, Dtk_PreviewPtr & outPreview );
59 
60 
66 
67 
68 
69  /*-----------------------------------------------------------------------------------------*/
70 
73  static void SetCreateConicEdges(const Dtk_bool inCreateConicEdges);
74  static void SetSurfaciqueMode(const Dtk_bool inSurfaciqueMode);
77  static void SetDisable2dProjectionForShadedView(const Dtk_bool inDisableProjection);
80  static void SetFileSwapStatus(const Dtk_bool inFileSwap);
82 
83  static void GetDetailledMetadata( Dtk_bool inStatus );
84  static void GetAllMetadata( Dtk_bool inStatus );
85 
88  static void SetAssemblyLvlGeomConfig(const Dtk_bool inStatus);
89 
90 };
91 
92 
93 #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)
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()
Dtk_string
This is a high level string class.
Definition: dtk_string.hpp:58
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()
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:725
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:19
ProeReader::EndComponent
Dtk_ErrorStatus EndComponent(Dtk_ComponentPtr &inComponent)
ProeReader::GetVersion
Dtk_Int32 GetVersion()
ProeReader::GetAllMetadata
static void GetAllMetadata(Dtk_bool inStatus)
Dtk_Node
This is the Node Class The Dtk_Node object is used to retrieve informations in a Dtk_ComponentPtr obj...
Definition: dtk_maindoc.hpp:230
Dtk_Int32
int32_t Dtk_Int32
Definition: define.h:687
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::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:85
SetAsDeprecated
SetAsDeprecated("2022.2", "Use ProeReader::SetFileSwap method instead.") void proer_allowFileSwap()
ProeReader::GetFilePreview
Dtk_ErrorStatus GetFilePreview(const Dtk_string &inInputFile, Dtk_PreviewPtr &outPreview)
ProeReader::SetSurfaciqueMode
static void SetSurfaciqueMode(const Dtk_bool inSurfaciqueMode)
Dtk_Component
This is the Component Class. The Dtk_ComponentPtr object is used as element into an assembly tree....
Definition: dtk_maindoc.hpp:563
ProeReader::CreateDocument
Dtk_ErrorStatus CreateDocument(const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)
ProeReader::CreateDocumentGraphical
Dtk_ErrorStatus CreateDocumentGraphical(const Dtk_string &inInputFile, Dtk_MainDocPtr &outDocument)