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