src/HYDROData/HYDROData_ImmersibleZone.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_ImmersibleZone_HeaderFile
  20 #define HYDROData_ImmersibleZone_HeaderFile
  21
  22 #include <HYDROData_NaturalObject.h>
  23
  24 class HYDROData_PolylineXY;
  25
  26 /**\class HYDROData_ImmersibleZone
  27  * \brief
  28  *
  29  */
  30 class HYDROData_ImmersibleZone : public HYDROData_NaturalObject
  31 {
  32 protected:
  33   /**
  34    * Enumeration of tags corresponding to the persistent object parameters.
  35    */
  36   enum DataTag
  37   {
  38     DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
  39     DataTag_Polyline,     ///< reference polyline
  40 };
  41
  42 public:
  43   DEFINE_STANDARD_RTTIEXT(HYDROData_ImmersibleZone, HYDROData_NaturalObject);
  44
  45   /**
  46    * Returns the kind of this object. Must be redefined in all objects of known type.
  47    */
  48   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_IMMERSIBLE_ZONE;}
  49
  50   /**
  51    * Dump object to Python script representation.
  52    */
  53   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
  54                                                      MapOfTreatedObjects& theTreatedObjects ) const;
  55
  56   /**
  57    * Returns the list of all reference objects of this object.
  58    */
  59   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
  60
  61   /**
  62    * Update the immersible zone object.
  63    * Call this method whenever you made changes for object data.
  64    */
  65   HYDRODATA_EXPORT virtual void Update();
  66
  67   /**
  68    * Checks that object has 2D presentation. Reimlemented to retun true.
  69    */
  70   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
  71
  72   /**
  73    * Returns the 3d shape of the object.
  74    */
  75   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
  76
  77   /**
  78    * Returns default filling color for new zone.
  79    */
  80   HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
  81
  82   /**
  83    * Returns default border color for new zone.
  84    */
  85   HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
  86
  87   /**
  88    * Sets reference polyline object for zone.
  89    */
  90   HYDRODATA_EXPORT virtual void SetPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
  91
  92   /**
  93    * Returns reference polyline object of zone.
  94    */
  95   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetPolyline() const;
  96
  97   /**
  98    * Remove reference polyline object of zone.
  99    */
 100   HYDRODATA_EXPORT virtual void RemovePolyline();
 101
 102   HYDRODATA_EXPORT TopoDS_Shape generateTopShape() const;
 103   HYDRODATA_EXPORT static TopoDS_Shape generateTopShape( const Handle(HYDROData_PolylineXY)& );
 104
 105 private:
 106
 107   /**
 108    * Create all necessary child group objects.
 109    */
 110   HYDRODATA_EXPORT void createGroupObjects();
 111
 112 protected:
 113
 114   friend class HYDROData_Iterator;
 115
 116   /**
 117    * Creates new object in the internal data structure. Use higher level objects
 118    * to create objects with real content.
 119    */
 120   HYDRODATA_EXPORT HYDROData_ImmersibleZone();
 121
 122   /**
 123    * Destructs properties of the object and object itself, removes it from the document.
 124    */
 125   virtual HYDRODATA_EXPORT ~HYDROData_ImmersibleZone();
 126 };
 127
 128 #endif