2 #ifndef HYDROData_Obstacle_HeaderFile
3 #define HYDROData_Obstacle_HeaderFile
5 #include "HYDROData_ArtificialObject.h"
7 DEFINE_STANDARD_HANDLE(HYDROData_Obstacle, HYDROData_ArtificialObject)
9 /**\class HYDROData_Obstacle
13 class HYDROData_Obstacle : public HYDROData_ArtificialObject
17 * Enumeration of tags corresponding to the persistent object parameters.
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 DataTag_Translation, ///< translation coefficients
28 DEFINE_STANDARD_RTTI(HYDROData_Obstacle);
31 * Returns the kind of this object. Must be redefined in all objects of known type.
33 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_OBSTACLE;}
36 * Dump object to Python script representation.
38 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
41 * Update the immersible zone object.
42 * Call this method whenever you made changes for object data.
44 HYDRODATA_EXPORT virtual void Update();
46 HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
49 * Checks that object has 2D presentation. Reimlemented to retun true.
51 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
54 * Returns the top shape of the object.
56 HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
59 * Returns the 3d shape of the object.
61 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
64 * Returns default filling color for new obstacle.
66 HYDRODATA_EXPORT static QColor DefaultFillingColor();
69 * Returns default border color for new obstacle.
71 HYDRODATA_EXPORT static QColor DefaultBorderColor();
75 * Sets the 3d shape of the object.
77 HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape );
82 * Imports shape from file containing geometrical object and sets this
83 * shape as the obstacle shape.
84 * The supported file types:
89 * \param theFilePath the path to file
90 * \return \c true if file has been successfully read
92 HYDRODATA_EXPORT virtual bool ImportFromFile( const QString& theFilePath );
95 * Stores the file path of the imported file.
96 * \param theFilePath file path
98 HYDRODATA_EXPORT void SetFilePath(const QString& theFilePath);
101 * Returns the imported file path.
103 HYDRODATA_EXPORT QString GetFilePath() const;
107 * Imports shape from IOR.
108 * \param theIOR the IOR of Geom object
109 * \return \c true if shape has been successfully imported
111 HYDRODATA_EXPORT virtual bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
114 * Stores the study entry of the imported GEOM object.
115 * \param theEntry GEOM object entry
117 HYDRODATA_EXPORT void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
120 * Returns the imported GEOM object entry.
122 HYDRODATA_EXPORT TCollection_AsciiString GetGeomObjectEntry() const;
126 * Translate the obstacle to the given distance.
128 HYDRODATA_EXPORT void Translate( const double theDx,
130 const double theDz );
135 * Returns default filling color for new object.
137 HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
140 * Returns default border color for new object.
142 HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
145 * Returns the type of child altitude object.
146 * Reimplemented to create obstacle altitude object.
148 HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
153 * Imports shape from the BREP file.
154 * \param theFilePath the path to file
155 * \return shape as TopoDS_Shape (null shape if import was failed)
157 TopoDS_Shape ImportBREP( const QString& theFilePath ) const;
160 * Imports shape from the IGES file.
161 * \param theFilePath the path to file
162 * \return shape as TopoDS_Shape (null shape if import was failed)
164 TopoDS_Shape ImportIGES( const QString& theFilePath ) const;
167 * Imports shape from the STEP file.
168 * \param theFilePath the path to file
169 * \return shape as TopoDS_Shape (null shape if import was failed)
171 TopoDS_Shape ImportSTEP( const QString& theFilePath ) const;
174 * Create all necessary child group objects.
176 void createGroupObjects();
179 * Sets the translation coefficients.
181 void setTranslation( const double theDx, const double theDy, const double theDz );
184 * Returns the translation coefficients.
186 bool getTranslation( double& theDx, double& theDy, double& theDz ) const;
190 friend class HYDROData_Iterator;
193 * Creates new object in the internal data structure. Use higher level objects
194 * to create objects with real content.
196 HYDRODATA_EXPORT HYDROData_Obstacle();
199 * Destructs properties of the object and object itself, removes it from the document.
201 virtual HYDRODATA_EXPORT ~HYDROData_Obstacle();