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 //    DataTag_LeftBank,
  62   };
  63
  64 public:
  65
  66   DEFINE_STANDARD_RTTI(HYDROData_Channel);
  67
  68 public:
  69
  70   /**
  71    * Creates the presentations(2D and 3D) by given guide line and profile.
  72    */
  73   HYDRODATA_EXPORT static bool CreatePresentations( const Handle(HYDROData_Polyline3D)& theGuideLine,
  74                                                     const Handle(HYDROData_Profile)&    theProfile,
  75                                                     PrsDefinition&                      thePrs );
  76
  77 public:
  78
  79   /**
  80    * Returns the kind of this object. Must be redefined in all objects of known type.
  81    */
  82   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_CHANNEL;}
  83
  84   /**
  85    * Dump object to Python script representation.
  86    */
  87   HYDRODATA_EXPORT virtual QStringList DumpToPython( 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 top shape of the object.
  96    */
  97   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
  98
  99   /**
 100    * Returns the 3d shape of the object.
 101    */
 102   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
 103
 104 //  /**
 105 //   * Returns the left bank of the object.
 106 //   */
 107 //  HYDRODATA_EXPORT virtual TopoDS_Wire GetLeftBank() const;
 108
 109  /**
 110    * Update the shape presentations of stream.
 111    * Call this method whenever you made changes for channel data.
 112    */
 113   HYDRODATA_EXPORT virtual void Update();
 114
 115   /**
 116    * Checks that object has 2D presentation. Reimlemented to retun true.
 117    */
 118   HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
 119
 120   /**
 121    * Returns default filling color for new channel.
 122    */
 123   HYDRODATA_EXPORT static QColor DefaultFillingColor();
 124
 125   /**
 126    * Returns default border color for new channel.
 127    */
 128   HYDRODATA_EXPORT static QColor DefaultBorderColor();
 129
 130
 131 public:
 132   // Public methods to work with Channel
 133
 134   /**
 135    * Sets reference guide line object for channel.
 136    */
 137   HYDRODATA_EXPORT virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine );
 138
 139   /**
 140    * Returns reference guide line object of channel.
 141    */
 142   HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline3D) GetGuideLine() const;
 143
 144   /**
 145    * Remove reference guide line object from channel.
 146    */
 147   HYDRODATA_EXPORT virtual void RemoveGuideLine();
 148
 149
 150   /**
 151    * Sets reference profile object for channel.
 152    */
 153   HYDRODATA_EXPORT virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile );
 154
 155   /**
 156    * Returns reference profile object of channel.
 157    */
 158   HYDRODATA_EXPORT virtual Handle(HYDROData_Profile) GetProfile() const;
 159
 160   /**
 161    * Remove reference profile object from channel.
 162    */
 163   HYDRODATA_EXPORT virtual void RemoveProfile();
 164
 165
 166 protected:
 167
 168   /**
 169    * Returns default filling color for new object.
 170    */
 171   HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
 172
 173   /**
 174    * Returns default border color for new object.
 175    */
 176   HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
 177
 178   /**
 179    * Returns the type of child altitude object.
 180    * Reimplemented to create chanel altitude object.
 181    */
 182   HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
 183
 184 protected:
 185
 186   friend class HYDROData_Iterator;
 187
 188   /**
 189    * Creates new object in the internal data structure. Use higher level objects
 190    * to create objects with real content.
 191    */
 192   HYDRODATA_EXPORT HYDROData_Channel();
 193
 194   /**
 195    * Destructs properties of the object and object itself, removes it from the document.
 196    */
 197   virtual HYDRODATA_EXPORT ~HYDROData_Channel();
 198 };
 199
 200 #endif