src/HYDROData/HYDROData_Channel.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_Channel_HeaderFile
  20 #define HYDROData_Channel_HeaderFile
  21
  22 #include "HYDROData_ArtificialObject.h"
  23
  24 #include <TopoDS_Face.hxx>
  25 #include <TopoDS_Wire.hxx>
  26
  27 class Handle(HYDROData_Polyline3D);
  28 class Handle(HYDROData_Profile);
  29 class TopTools_SequenceOfShape;
  30 class TopTools_ListOfShape;
  31
  32 DEFINE_STANDARD_HANDLE(HYDROData_Channel, HYDROData_ArtificialObject)
  33
  34 /**\class HYDROData_Channel
  35  * \brief
  36  *
  37  */
  38 class HYDROData_Channel : public HYDROData_ArtificialObject
  39 {
  40 public:
  41
  42   struct PrsDefinition
  43   {
  44     TopoDS_Shape myPrs3D;
  45     TopoDS_Face  myPrs2D;
  46     TopoDS_Wire  myLeftBank;
  47     TopoDS_Wire  myRightBank;
  48     TopoDS_Wire  myInlet;
  49     TopoDS_Wire  myOutlet;
  50   };
  51
  52 protected:
  53   /**
  54    * Enumeration of tags corresponding to the persistent object parameters.
  55    */
  56   enum DataTag
  57   {
  58     DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
  59     DataTag_GuideLine,
  60     DataTag_Profile,
  61   };
  62
  63 public:
  64
  65   DEFINE_STANDARD_RTTI(HYDROData_Channel);
  66
  67 public:
  68
  69   /**
  70    * Creates the presentations(2D and 3D) by given guide line and profile.
  71    */
  72   HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_Polyline3D)& theGuideLine,
  73                                                     const Handle(HYDROData_Profile)&    theProfile,
  74                                                     PrsDefinition&                      thePrs );
  75
  76 public:
  77
  78   /**
  79    * Returns the kind of this object. Must be redefined in all objects of known type.
  80    */
  81   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_CHANNEL;}
  82
  83   /**
  84    * Dump object to Python script representation.
  85    */
  86   HYDRODATA_EXPORT virtual QStringList DumpToPython( const QString& thePyScriptPath,
  87                                                      MapOfTreatedObjects& theTreatedObjects ) const;
  88
  89   /**
  90    * Returns the list of all reference objects of this object.
  91    */
  92   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
  93
  94   /**
  95    * Returns the left edge of the channel.
  96    */
  97   HYDRODATA_EXPORT virtual TopoDS_Shape GetLeftShape() const;
  98
  99   /**
 100    * Returns the right edge of the channel.
 101    */
 102   HYDRODATA_EXPORT virtual TopoDS_Shape GetRightShape() const;
 103
 104   /**
 105    * Update the shape presentations of stream.
 106    * Call this method whenever you made changes for channel data.
 107    */
 108   HYDRODATA_EXPORT virtual void Update();
 109
 110   /**
 111    * Checks that object has 2D presentation. Reimlemented to retun true.
 112    */
 113   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
 114
 115   /**
 116    * Returns default filling color for new channel.
 117    */
 118   HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
 119
 120   /**
 121    * Returns default border color for new channel.
 122    */
 123   HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
 124
 125
 126 public:
 127   // Public methods to work with Channel
 128
 129   /**
 130    * Sets reference guide line object for channel.
 131    */
 132   HYDRODATA_EXPORT virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine );
 133
 134   /**
 135    * Returns reference guide line object of channel.
 136    */
 137   HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetGuideLine() const;
 138
 139   /**
 140    * Remove reference guide line object from channel.
 141    */
 142   HYDRODATA_EXPORT virtual void RemoveGuideLine();
 143
 144
 145   /**
 146    * Sets reference profile object for channel.
 147    */
 148   HYDRODATA_EXPORT virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile );
 149
 150   /**
 151    * Returns reference profile object of channel.
 152    */
 153   HYDRODATA_EXPORT virtual Handle(HYDROData_Profile) GetProfile() const;
 154
 155   /**
 156    * Remove reference profile object from channel.
 157    */
 158   HYDRODATA_EXPORT virtual void RemoveProfile();
 159
 160
 161 protected:
 162   /**
 163    * Returns the type of child altitude object.
 164    * Reimplemented to create chanel altitude object.
 165    */
 166   HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
 167
 168 protected:
 169
 170   friend class HYDROData_Iterator;
 171
 172   /**
 173    * Creates new object in the internal data structure. Use higher level objects
 174    * to create objects with real content.
 175    */
 176   HYDRODATA_EXPORT HYDROData_Channel();
 177
 178   /**
 179    * Destructs properties of the object and object itself, removes it from the document.
 180    */
 181   virtual HYDRODATA_EXPORT ~HYDROData_Channel();
 182 };
 183
 184 #endif