src/HYDROPy/HYDROData_Channel.sip

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 %ExportedHeaderCode
  24 #include "HYDROData_Channel.h"
  25 %End
  26
  27 class HYDROData_Channel : public HYDROData_ArtificialObject
  28 {
  29 %TypeHeaderCode
  30 #include "HYDROData_Channel.h"
  31 %End
  32
  33 public:
  34   /**
  35    * Returns default filling color for new channel.
  36    */
  37   static QColor DefaultFillingColor();
  38
  39   /**
  40    * Returns default border color for new channel.
  41    */
  42   static QColor DefaultBorderColor();
  43
  44
  45 public:
  46   // Public methods to work with Channel
  47
  48   /**
  49    * Sets reference guide line object for channel.
  50    */
  51   virtual bool SetGuideLine( const Handle(HYDROData_Polyline3D)& theGuideLine );
  52
  53   /**
  54    * Returns reference guide line object of channel.
  55    */
  56   virtual Handle(HYDROData_Polyline3D) GetGuideLine() const;
  57
  58   /**
  59    * Remove reference guide line object from channel.
  60    */
  61   virtual void RemoveGuideLine();
  62
  63
  64   /**
  65    * Sets reference profile object for channel.
  66    */
  67   virtual bool SetProfile( const Handle(HYDROData_Profile)& theProfile );
  68
  69   /**
  70    * Returns reference profile object of channel.
  71    */
  72   virtual Handle(HYDROData_Profile) GetProfile() const;
  73
  74   /**
  75    * Remove reference profile object from channel.
  76    */
  77   virtual void RemoveProfile();
  78
  79
  80 protected:
  81
  82   /**
  83    * Creates new object in the internal data structure. Use higher level objects
  84    * to create objects with real content.
  85    */
  86   HYDROData_Channel();
  87
  88   /**
  89    * Destructs properties of the object and object itself, removes it from the document.
  90    */
  91   virtual ~HYDROData_Channel();
  92 };