src/HYDROData/HYDROData_BCPolygon.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #ifndef HYDROData_BCPolygon_HeaderFile
  20 #define HYDROData_BCPolygon_HeaderFile
  21
  22 #include <HYDROData_Object.h>
  23
  24 class HYDROData_PolylineXY;
  25
  26 /**\class HYDROData_BCPolygon
  27  * \brief
  28  *
  29  */
  30 class HYDROData_BCPolygon : public HYDROData_Object
  31 {
  32 protected:
  33   /**
  34    * Enumeration of tags corresponding to the persistent object parameters.
  35    */
  36   enum DataTag
  37   {
  38     DataTag_First = HYDROData_Object::DataTag_First + 100,
  39     DataTag_Polyline,     ///< reference polyline
  40     DataTag_BoundaryType  ///< boundary type: cutting(1), bounding(2), selection(3)
  41 };
  42
  43 public:
  44   DEFINE_STANDARD_RTTIEXT(HYDROData_BCPolygon, HYDROData_Object);
  45
  46   /**
  47    * Returns the kind of this object. Must be redefined in all objects of known type.
  48    */
  49   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_BC_POLYGON;}
  50
  51   /**
  52    * Dump object to Python script representation.
  53    */
  54   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
  55                                                      MapOfTreatedObjects& theTreatedObjects ) const;
  56
  57   /**
  58    * Returns the list of all reference objects of this object.
  59    */
  60   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
  61
  62   /**
  63    * Update the object.
  64    * Call this method whenever you made changes for object data.
  65    */
  66   HYDRODATA_EXPORT virtual void Update();
  67
  68   /**
  69    * Update the object with new top shape.
  70    * Call this method whenever you made changes for object data.
  71    */
  72   HYDRODATA_EXPORT void Update(const TopoDS_Shape& theTopShape);
  73
  74   /**
  75    * Checks that object has 2D presentation. Reimlemented to retun true.
  76    */
  77   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
  78
  79   /**
  80    * Returns the 3d shape of the object.
  81    */
  82   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
  83
  84   /**
  85    * Returns default filling color for new zone.
  86    */
  87   HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
  88
  89   /**
  90    * Returns default border color for new zone.
  91    */
  92   HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
  93
  94   /**
  95    * Sets reference polyline object for zone.
  96    */
  97   HYDRODATA_EXPORT virtual void SetPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
  98
  99   /**
 100    * Returns reference polyline object of zone.
 101    */
 102   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetPolyline() const;
 103
 104   /**
 105    * Remove reference polyline object of zone.
 106    */
 107   HYDRODATA_EXPORT virtual void RemovePolyline();
 108
 109   HYDRODATA_EXPORT TopoDS_Shape generateTopShape() const;
 110
 111   HYDRODATA_EXPORT static TopoDS_Shape generateTopShape( const Handle(HYDROData_PolylineXY)& );
 112
 113   HYDRODATA_EXPORT int GetBoundaryType() const;
 114
 115   HYDRODATA_EXPORT void SetBoundaryType( int ) const;
 116
 117 protected:
 118
 119   friend class HYDROData_Iterator;
 120
 121   /**
 122    * Creates new object in the internal data structure. Use higher level objects
 123    * to create objects with real content.
 124    */
 125   HYDRODATA_EXPORT HYDROData_BCPolygon();
 126
 127   /**
 128    * Destructs properties of the object and object itself, removes it from the document.
 129    */
 130   virtual HYDRODATA_EXPORT ~HYDROData_BCPolygon();
 131 };
 132
 133 #endif