1 // Copyright (C) 2007-2015 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, or (at your option) any later version.
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
23 #ifndef HYDROData_ImmersibleZone_HeaderFile
24 #define HYDROData_ImmersibleZone_HeaderFile
26 #include <HYDROData_NaturalObject.h>
28 DEFINE_STANDARD_HANDLE(HYDROData_ImmersibleZone, HYDROData_NaturalObject)
30 class Handle(HYDROData_PolylineXY);
32 /**\class HYDROData_ImmersibleZone
36 class HYDROData_ImmersibleZone : public HYDROData_NaturalObject
40 * Enumeration of tags corresponding to the persistent object parameters.
44 DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
45 DataTag_Polyline, ///< reference polyline
49 DEFINE_STANDARD_RTTI(HYDROData_ImmersibleZone);
52 * Returns the kind of this object. Must be redefined in all objects of known type.
54 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_IMMERSIBLE_ZONE;}
57 * Dump object to Python script representation.
59 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
62 * Returns the list of all reference objects of this object.
64 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
67 * Update the immersible zone object.
68 * Call this method whenever you made changes for object data.
70 HYDRODATA_EXPORT virtual void Update();
73 * Checks that object has 2D presentation. Reimlemented to retun true.
75 HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
78 * Returns the top shape of the object.
80 HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
83 * Returns the 3d shape of the object.
85 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
88 * Returns default filling color for new zone.
90 HYDRODATA_EXPORT static QColor DefaultFillingColor();
93 * Returns default border color for new zone.
95 HYDRODATA_EXPORT static QColor DefaultBorderColor();
98 * Sets reference polyline object for zone.
100 HYDRODATA_EXPORT virtual void SetPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
103 * Returns reference polyline object of zone.
105 HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetPolyline() const;
108 * Remove reference polyline object of zone.
110 HYDRODATA_EXPORT virtual void RemovePolyline();
112 HYDRODATA_EXPORT TopoDS_Shape generateTopShape() const;
113 HYDRODATA_EXPORT static TopoDS_Shape generateTopShape( const Handle(HYDROData_PolylineXY)& );
118 * Returns default filling color for new object.
120 HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
123 * Returns default border color for new object.
125 HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
130 * Create all necessary child group objects.
132 HYDRODATA_EXPORT void createGroupObjects();
136 friend class HYDROData_Iterator;
139 * Creates new object in the internal data structure. Use higher level objects
140 * to create objects with real content.
142 HYDRODATA_EXPORT HYDROData_ImmersibleZone();
145 * Destructs properties of the object and object itself, removes it from the document.
147 virtual HYDRODATA_EXPORT ~HYDROData_ImmersibleZone();