]> SALOME platform Git repositories - modules/hydro.git/blob - src/HYDROData/HYDROData_Obstacle.h
Salome HOME
Dump obstacle object to python script.
[modules/hydro.git] / src / HYDROData / HYDROData_Obstacle.h
1
2 #ifndef HYDROData_Obstacle_HeaderFile
3 #define HYDROData_Obstacle_HeaderFile
4
5 #include "HYDROData_ArtificialObject.h"
6
7 DEFINE_STANDARD_HANDLE(HYDROData_Obstacle, HYDROData_ArtificialObject)
8
9 /**\class HYDROData_Obstacle
10  * \brief 
11  *
12  */
13 class HYDROData_Obstacle : public HYDROData_ArtificialObject
14 {
15 protected:
16   /**
17    * Enumeration of tags corresponding to the persistent object parameters.
18    */
19   enum DataTag
20   {
21     DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
22     DataTag_GeomObjectEntry, ///< study entry of the imported GEOM object
23     DataTag_FilePath ///< imported file path
24   };
25
26 public:
27   DEFINE_STANDARD_RTTI(HYDROData_Obstacle);
28
29   /**
30    * Returns the kind of this object. Must be redefined in all objects of known type.
31    */
32   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_OBSTACLE;}
33
34   /**
35    * Dump object to Python script representation.
36    */
37   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
38
39   /**
40    * Update the immersible zone object.
41    * Call this method whenever you made changes for object data.
42    */
43   HYDRODATA_EXPORT virtual void Update();
44
45   /**
46    * Returns the top shape of the object.
47    */
48   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
49
50   /**
51    * Returns the 3d shape of the object.
52    */
53   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
54
55   /**
56    * Returns default filling color for new obstacle.
57    */
58   HYDRODATA_EXPORT static QColor DefaultFillingColor();
59
60   /**
61    * Returns default border color for new obstacle.
62    */
63   HYDRODATA_EXPORT static QColor DefaultBorderColor();
64
65
66   /**
67    * Sets the 3d shape of the object.
68    */
69   HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape );
70
71 public:
72
73   /**
74    * Imports shape from file containing geometrical object and sets this
75    * shape as the obstacle shape.
76    * The supported file types:
77    *  - BREP
78    *  - IGES
79    *  - STEP
80    *  - ACIS
81    * \param theFilePath the path to file
82    * \return \c true if file has been successfully read
83    */
84   HYDRODATA_EXPORT virtual bool ImportFromFile( const QString& theFilePath );
85
86   /**
87    * Imports shape from IOR.
88    * \param theIOR the IOR of Geom object
89    * \return \c true if shape has been successfully imported
90    */
91   HYDRODATA_EXPORT virtual bool ImportFromGeomIOR( const QString& theIOR );
92
93   /**
94    * Stores the file path of the imported file.
95    * \param theFilePath file path
96    */
97   HYDRODATA_EXPORT void SetFilePath(const QString& theFilePath);
98
99   /**
100    * Returns the imported file path.
101    */
102   HYDRODATA_EXPORT QString GetFilePath() const;
103
104    /**
105    * Stores the study entry of the imported GEOM object.
106    * \param theEntry GEOM object entry
107    */
108   HYDRODATA_EXPORT void SetGeomObjectEntry( const QString& theEntry );
109
110   /**
111    * Returns the imported GEOM object entry.
112    */
113   HYDRODATA_EXPORT QString GetGeomObjectEntry() const;
114
115 protected:
116
117   /**
118    * Returns default filling color for new object.
119    */
120   HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
121
122   /**
123    * Returns default border color for new object.
124    */
125   HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
126
127   /**
128    * Returns the type of child altitude object.
129    * Reimplemented to create obstacle altitude object.
130    */
131   HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
132
133 private:
134
135   /**
136    * Create all necessary child group objects.
137    */
138   HYDRODATA_EXPORT void createGroupObjects();
139
140 protected:
141
142   friend class HYDROData_Iterator;
143
144   /**
145    * Creates new object in the internal data structure. Use higher level objects 
146    * to create objects with real content.
147    */
148   HYDRODATA_EXPORT HYDROData_Obstacle();
149
150   /**
151    * Destructs properties of the object and object itself, removes it from the document.
152    */
153   virtual HYDRODATA_EXPORT ~HYDROData_Obstacle();
154
155 private:
156   /**
157    * Imports shape from the BREP file.
158    * \param theFilePath the path to file
159    * \return shape as TopoDS_Shape (null shape if import was failed)
160    */
161   TopoDS_Shape ImportBREP( const QString& theFilePath ) const;
162
163   /**
164    * Imports shape from the IGES file.
165    * \param theFilePath the path to file
166    * \return shape as TopoDS_Shape (null shape if import was failed)
167    */
168   TopoDS_Shape ImportIGES( const QString& theFilePath ) const;
169
170   /**
171    * Imports shape from the STEP file.
172    * \param theFilePath the path to file
173    * \return shape as TopoDS_Shape (null shape if import was failed)
174    */
175   TopoDS_Shape ImportSTEP( const QString& theFilePath ) const;
176 };
177
178 #endif