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