1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License.
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
24 #include <HYDROData_Obstacle.h>
27 class HYDROData_Obstacle : public HYDROData_ArtificialObject
30 #include <HYDROData_Obstacle.h>
35 * Returns default filling color for new obstacle.
37 static QColor DefaultFillingColor();
40 * Returns default border color for new obstacle.
42 static QColor DefaultBorderColor();
47 * Imports shape from file containing geometrical object and sets this
48 * shape as the obstacle shape.
49 * The supported file types:
54 * \param theFilePath the path to file
55 * \return \c true if file has been successfully read
57 bool ImportFromFile( const QString& theFilePath );
61 * Imports shape from IOR.
62 * \param theIOR the IOR of Geom object
63 * \return \c true if shape has been successfully imported
65 bool ImportFromGeomIOR( const QString& theIOR );
68 * Stores the file path of the imported file.
69 * \param theFilePath file path
71 void SetFilePath(const QString& theFilePath);
74 * Returns the imported file path.
76 QString GetFilePath() const;
79 * Stores the study entry of the imported GEOM object.
80 * \param theEntry GEOM object entry
82 void SetGeomObjectEntry(const QString& theEntry);
85 * Returns the imported GEOM object entry.
87 QString GetGeomObjectEntry() const;
92 * Creates new object in the internal data structure. Use higher level objects
93 * to create objects with real content.
98 * Destructs properties of the object and object itself, removes it from the document.
100 virtual ~HYDROData_Obstacle();