DATAKIT SDK  V2026.2
dtk_ugrReader.hpp
Go to the documentation of this file.
1 #ifndef _UTIL_UGR_READER_HPP_
2 #define _UTIL_UGR_READER_HPP_
3 
4 class UgReader : public Dtk_Reader
5 {
6 protected:
7 public:
8  virtual ~UgReader() = 0;
9  static Dtk_bool Enable();
10 
11  //! [Options]
12  //! \brief Use to manage an assembly file as a part
13  //! \param inManageAsPart DTK_TRUE to manage an assembly as a part
14  //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
15  static void SetManageAssemblyAsPart( Dtk_bool inManageAsPart );
16 
17  //! \brief remove default name for entity as point , line , arc ...
18  //! \param inRemoveDefaultName DTK_TRUE to remove the default name
19  //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
20  static void RemoveDefaultName( Dtk_bool inRemoveDefaultName );
21 
22  //! \brief remove zoomfit camera
23  //! \param inRemoveZoomfit DTK_TRUE to remove the zoomfit
24  //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
25  static void RemoveZoomFitCamera( Dtk_bool inRemoveZoomfit );
26 
27  //! \brief use this cdf file
28  //! \param inCdfFilename name of cdf file
29  //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
30  static void UseCdfFilename( const Dtk_string& inCdfFilename );
31 
32  //! \brief keep geometry name instead feature name
33  //! \param inRemoveFeatureName DTK_TRUE to remove the feature name
34  //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
35  static void RemoveFeatureName( Dtk_bool inRemoveFeatureName );
36 
37  //! \brief remove the feature tree
38  //! \param inRemoveFeatureTree DTK_TRUE to remove the feature tree
39  //! \warning call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
40  static void RemoveFeatureTree( Dtk_bool inRemoveFeatureTree );
41 
42 
43  //! \brief split the name for this entity type
44  //! \param inType type_detk to split name
45  static void AddSplitFeatureName(type_detk inType);
46  static void ClearSplitFeatureName();
47  //! [Options]
48 
50  void * GetSearchEngine();
51 };
52 
53 class XmtReader : public UgReader
54 {
55 protected:
56 public:
58  static Dtk_bool Enable();
59 };
60 
61 
62 //! \deprecated : use static method
63 SetAsDeprecated( "2026.2", "Use static" )
64 void ugr_ActiveSubstituteFileVersion(Dtk_bool inSub);
65 //! \deprecated : use static method
66 SetAsDeprecated( "2026.2", "Use static" )
67 void ugr_ActivateAnalyticSurface(Dtk_bool inActivate);
68 
69 
70 #endif
UgReader::RemoveFeatureTree
static void RemoveFeatureTree(Dtk_bool inRemoveFeatureTree)
remove the feature tree
UgReader::ClearSplitFeatureName
static void ClearSplitFeatureName()
UgReader
Definition: dtk_ugrReader.hpp:5
Dtk_Reader
Definition: dtk_reader.hpp:15
Dtk_string
This is a high level string class.
Definition: dtk_string.hpp:53
UgReader::RemoveFeatureName
static void RemoveFeatureName(Dtk_bool inRemoveFeatureName)
keep geometry name instead feature name
Dtk_bool
char Dtk_bool
Definition: define.h:717
UgReader::UseCdfFilename
static void UseCdfFilename(const Dtk_string &inCdfFilename)
use this cdf file
UgReader::Enable
static Dtk_bool Enable()
XmtReader
Definition: dtk_ugrReader.hpp:54
UgReader::GetSubReader
Dtk_Reader * GetSubReader()
[Options]
type_detk
type_detk
Definition: define.h:21
UgReader::~UgReader
virtual ~UgReader()=0
XmtReader::Enable
static Dtk_bool Enable()
UgReader::SetManageAssemblyAsPart
static void SetManageAssemblyAsPart(Dtk_bool inManageAsPart)
Use to manage an assembly file as a part.
UgReader::RemoveDefaultName
static void RemoveDefaultName(Dtk_bool inRemoveDefaultName)
remove default name for entity as point , line , arc ...
XmtReader::XmtReader
XmtReader()
UgReader::RemoveZoomFitCamera
static void RemoveZoomFitCamera(Dtk_bool inRemoveZoomfit)
remove zoomfit camera
UgReader::GetSearchEngine
void * GetSearchEngine()
SetAsDeprecated
SetAsDeprecated("2026.2", "Use static") void ugr_ActiveSubstituteFileVersion(Dtk_bool inSub)
UgReader::AddSplitFeatureName
static void AddSplitFeatureName(type_detk inType)
split the name for this entity type