DATAKIT SDK  V2026.3
dtk_Catiav5Reader.hpp
Go to the documentation of this file.
1 #ifndef _UTIL_G5R_READER_HPP_
2 #define _UTIL_G5R_READER_HPP_
3 
4 #include "def/define.h"
5 #include "util/dtk_reader.hpp"
6 class Dtk_SearchFileEngine;
7 
8 class CatiaV5Reader : public Dtk_Reader
9 {
10 
11 public:
12  virtual ~CatiaV5Reader() = 0;
13  static Dtk_bool Enable();
14 
15  //For internal use only
16  Dtk_SearchFileEngine* GetSearchEngine();
17 
18  //! \brief Lets handle 2d Detail Sheets filtering. default value is DTK_TRUE.
19  //! \param inFiltered DTK_TRUE to filter or DTK_FALSE otherwise.
20  //! \warning please call it before the Dtk_API::ReadComponent call.
21  static void SetConfigV52dFilterDetailSheets( Dtk_bool inFiltered );
22 
23  //! \brief Lets Process CGM V5 pictures as Dtk_CompositeEntity whereas a Dtk_picture. default value is DTK_TRUE.
24  //! \param inProcessAsCompositeEntities DTK_TRUE to process as Dtk_CompositeEntity. DTK_FALSE as a Dtk_picture.
25  //! \warning please call it before the Dtk_API::ReadComponent call.
26  static void SetConfigV5ReadCGMPicturesAsCompositeEntities( Dtk_bool inProcessAsCompositeEntities );
27 
28  //! \brief Activate the new FDT->Geom Link reading. default value is DTK_TRUE.
29  //! \param inActivateNewFDTGeomLinks DTK_TRUE to activate the new reading. DTK_FALSE otherwise.
30  //! \warning beta feature. Use it at your own risk.
31  static void SetConfigV5ActivateNewFDTGeomLinks( Dtk_bool inActivateNewFDTGeomLinks );
32 
33  //! [Options]
34  //! \brief Reverses the orientation of surfacic faces.
36 
37  //! \brief instantiation of virtual component
38  //! \param [in] inVal : 1 Enable
39  //! 0 Disable ( default )
40  //!
41  static void SetInstantiationOfVirtualComponent(const Dtk_bool& inVal);
42 
43  //! \brief Configures the topological persistent name generation mode.
44  //! \param [in] inVal
45  //! 0 : Generate a string based on the entity history.
46  //! -1 : Generate an identifier (default behavior).
47  static void SetTopologicalPersistentNameMode( const Dtk_Int32& inVal );
48  //! [Options]
49 };
50 
51 //! \brief read external CATMaterial files
52 //! \param [in] inVal : 1 Enable ( default )
53 //! 0 Disable
55 
56 //! \deprecated Use CatiaV5Reader::EnableReversedOrientationSurfacicFace method instead.
57 SetAsDeprecated( "2023.3", "Use CatiaV5Reader::EnableReversedOrientationSurfacicFace method instead." )
58 void catiav5r_SetReversedOrientationSurfacicFace_Deprecated233(Dtk_bool inOldOrient);
59 
60 //! \Iterate through the parts while building the assembly tree
61 //! \param [in] inVal : 1 Enable
62 //! 0 Disable (default)
64 
66 
68 
69 //! \deprecated Use CatiaV5Reader::SetConfigV52dFilterDetailSheets method instead.
70 SetAsDeprecated( "2022.1", "Use CatiaV5Reader::SetConfigV52dFilterDetailSheets method instead." )
71 void catiav5r_SetCfgV52dFilterDetailSheets_Deprecated221( Dtk_bool inFiltered );
72 
73 
74 //! \deprecated Use CatiaV5Reader::SetConfigV5ReadCGMPicturesAsCompositeEntities method instead.
75 SetAsDeprecated( "2022.1", "Use CatiaV5Reader::SetConfigV5ReadCGMPicturesAsCompositeEntities method instead." )
76 void catiav5r_SetCfgV5ReadCGMPicturesAsCompositeEntities_Deprecated221( Dtk_bool inProcessAsCompositeEntities );
77 
78 #endif
79 
CatiaV5Reader::~CatiaV5Reader
virtual ~CatiaV5Reader()=0
SetAsDeprecated
SetAsDeprecated("2023.3", "Use CatiaV5Reader::EnableReversedOrientationSurfacicFace method instead.") void catiav5r_SetReversedOrientationSurfacicFace_Deprecated233(Dtk_bool inOldOrient)
Dtk_Reader
Definition: dtk_reader.hpp:15
CatiaV5Reader::SetConfigV5ReadCGMPicturesAsCompositeEntities
static void SetConfigV5ReadCGMPicturesAsCompositeEntities(Dtk_bool inProcessAsCompositeEntities)
Lets Process CGM V5 pictures as Dtk_CompositeEntity whereas a Dtk_picture. default value is DTK_TRUE.
CatiaV5Reader::GetSearchEngine
Dtk_SearchFileEngine * GetSearchEngine()
Dtk_bool
char Dtk_bool
Definition: define.h:724
catiav5r_GetLanguage
dtk_language catiav5r_GetLanguage()
CatiaV5Reader::SetConfigV5ActivateNewFDTGeomLinks
static void SetConfigV5ActivateNewFDTGeomLinks(Dtk_bool inActivateNewFDTGeomLinks)
Activate the new FDT->Geom Link reading. default value is DTK_TRUE.
CatiaV5Reader::Enable
static Dtk_bool Enable()
CatiaV5Reader::EnableReversedOrientationSurfacicFace
static void EnableReversedOrientationSurfacicFace()
Reverses the orientation of surfacic faces.
Dtk_Int32
int32_t Dtk_Int32
Definition: define.h:686
CatiaV5Reader::SetConfigV52dFilterDetailSheets
static void SetConfigV52dFilterDetailSheets(Dtk_bool inFiltered)
Lets handle 2d Detail Sheets filtering. default value is DTK_TRUE.
catiav5r_SetCfgV5ReadAsmWithoutPart
void catiav5r_SetCfgV5ReadAsmWithoutPart(const Dtk_bool &inVal)
CatiaV5Reader
Definition: dtk_Catiav5Reader.hpp:9
dtk_language
dtk_language
Definition: define.h:650
define.h
CatiaV5Reader::SetInstantiationOfVirtualComponent
static void SetInstantiationOfVirtualComponent(const Dtk_bool &inVal)
instantiation of virtual component
SetReadExternalCATMaterialFile
void SetReadExternalCATMaterialFile(const Dtk_bool &inVal)
read external CATMaterial files
dtk_reader.hpp
CatiaV5Reader::SetTopologicalPersistentNameMode
static void SetTopologicalPersistentNameMode(const Dtk_Int32 &inVal)
Configures the topological persistent name generation mode.
catiav5r_SetLanguage
void catiav5r_SetLanguage(dtk_language inLanguage)