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   bool SetGuideLine( HYDROData_Polyline3D theGuideLine )
  52   [bool ( const Handle_HYDROData_Polyline3D& )];
  53   %MethodCode
  54     Handle(HYDROData_Polyline3D) aRef =
  55       Handle(HYDROData_Polyline3D)::DownCast( createHandle( a0 ) );
  56     if ( !aRef.IsNull() )
  57     {
  58       Py_BEGIN_ALLOW_THREADS
  59       sipRes = sipSelfWasArg ? sipCpp->HYDROData_Channel::SetGuideLine( aRef ):
  60                                sipCpp->SetGuideLine( aRef );
  61       Py_END_ALLOW_THREADS
  62     }
  63   %End
  64
  65   /**
  66    * Returns reference guide line object of channel.
  67    */
  68   HYDROData_Polyline3D GetGuideLine() const
  69   [Handle_HYDROData_Polyline3D ()];
  70   %MethodCode
  71     Handle(HYDROData_Polyline3D) aRef;
  72
  73     Py_BEGIN_ALLOW_THREADS
  74     aRef = sipSelfWasArg ? sipCpp->HYDROData_Channel::GetGuideLine() :
  75                            sipCpp->GetGuideLine();
  76     Py_END_ALLOW_THREADS
  77
  78     sipRes = (HYDROData_Polyline3D*)createPointer( aRef );
  79   %End
  80
  81   /**
  82    * Remove reference guide line object from channel.
  83    */
  84   void RemoveGuideLine();
  85
  86
  87   /**
  88    * Sets reference profile object for channel.
  89    */
  90   bool SetProfile( HYDROData_Profile theProfile )
  91   [bool ( const Handle_HYDROData_Profile& )];
  92   %MethodCode
  93     Handle(HYDROData_Profile) aRef =
  94       Handle(HYDROData_Profile)::DownCast( createHandle( a0 ) );
  95     if ( !aRef.IsNull() )
  96     {
  97       Py_BEGIN_ALLOW_THREADS
  98       sipRes = sipSelfWasArg ? sipCpp->HYDROData_Channel::SetProfile( aRef ):
  99                                sipCpp->SetProfile( aRef );
 100       Py_END_ALLOW_THREADS
 101     }
 102   %End
 103
 104   /**
 105    * Returns reference profile object of channel.
 106    */
 107   HYDROData_Profile GetProfile() const
 108   [Handle_HYDROData_Profile ()];
 109   %MethodCode
 110     Handle(HYDROData_Profile) aRef;
 111
 112     Py_BEGIN_ALLOW_THREADS
 113     aRef = sipSelfWasArg ? sipCpp->HYDROData_Channel::GetProfile() :
 114                            sipCpp->GetProfile();
 115     Py_END_ALLOW_THREADS
 116
 117     sipRes = (HYDROData_Profile*)createPointer( aRef );
 118   %End
 119
 120   /**
 121    * Remove reference profile object from channel.
 122    */
 123   void RemoveProfile();
 124
 125
 126 protected:
 127
 128   /**
 129    * Creates new object in the internal data structure. Use higher level objects
 130    * to create objects with real content.
 131    */
 132   HYDROData_Channel();
 133
 134   /**
 135    * Destructs properties of the object and object itself, removes it from the document.
 136    */
 137   virtual ~HYDROData_Channel();
 138 };