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();
47 * Checks that object has 2D presentation. Reimlemented to retun true.
49 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
52 * Returns the top shape of the object.
54 HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
57 * Returns the 3d shape of the object.
59 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
62 * Returns default filling color for new obstacle.
64 HYDRODATA_EXPORT static QColor DefaultFillingColor();
67 * Returns default border color for new obstacle.
69 HYDRODATA_EXPORT static QColor DefaultBorderColor();
73 * Sets the 3d shape of the object.
75 HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape );
80 * Imports shape from file containing geometrical object and sets this
81 * shape as the obstacle shape.
82 * The supported file types:
87 * \param theFilePath the path to file
88 * \return \c true if file has been successfully read
90 HYDRODATA_EXPORT virtual bool ImportFromFile( const QString& theFilePath );
93 * Stores the file path of the imported file.
94 * \param theFilePath file path
96 HYDRODATA_EXPORT void SetFilePath(const QString& theFilePath);
99 * Returns the imported file path.
101 HYDRODATA_EXPORT QString GetFilePath() const;
105 * Imports shape from IOR.
106 * \param theIOR the IOR of Geom object
107 * \return \c true if shape has been successfully imported
109 HYDRODATA_EXPORT virtual bool ImportFromGeomIOR( const TCollection_AsciiString& theIOR );
112 * Stores the study entry of the imported GEOM object.
113 * \param theEntry GEOM object entry
115 HYDRODATA_EXPORT void SetGeomObjectEntry( const TCollection_AsciiString& theEntry );
118 * Returns the imported GEOM object entry.
120 HYDRODATA_EXPORT TCollection_AsciiString GetGeomObjectEntry() const;
124 * Translate the obstacle to the given distance.
126 HYDRODATA_EXPORT void Translate( const double theDx,
128 const double theDz );
133 * Returns default filling color for new object.
135 HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
138 * Returns default border color for new object.
140 HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
143 * Returns the type of child altitude object.
144 * Reimplemented to create obstacle altitude object.
146 HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
151 * Imports shape from the BREP file.
152 * \param theFilePath the path to file
153 * \return shape as TopoDS_Shape (null shape if import was failed)
155 TopoDS_Shape ImportBREP( const QString& theFilePath ) const;
158 * Imports shape from the IGES file.
159 * \param theFilePath the path to file
160 * \return shape as TopoDS_Shape (null shape if import was failed)
162 TopoDS_Shape ImportIGES( const QString& theFilePath ) const;
165 * Imports shape from the STEP file.
166 * \param theFilePath the path to file
167 * \return shape as TopoDS_Shape (null shape if import was failed)
169 TopoDS_Shape ImportSTEP( const QString& theFilePath ) const;
172 * Create all necessary child group objects.
174 void createGroupObjects();
177 * Sets the translation coefficients.
179 void setTranslation( const double theDx, const double theDy, const double theDz );
182 * Returns the translation coefficients.
184 bool getTranslation( double& theDx, double& theDy, double& theDz ) const;
188 friend class HYDROData_Iterator;
191 * Creates new object in the internal data structure. Use higher level objects
192 * to create objects with real content.
194 HYDRODATA_EXPORT HYDROData_Obstacle();
197 * Destructs properties of the object and object itself, removes it from the document.
199 virtual HYDRODATA_EXPORT ~HYDROData_Obstacle();