src/HYDROPy/HYDROData_Polyline3D.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_Polyline3D.h"
  25 %End
  26
  27 class HYDROData_Polyline3D : public HYDROData_Object
  28 {
  29 %TypeHeaderCode
  30 #include "HYDROData_Polyline3D.h"
  31 %End
  32
  33 public:
  34   /**
  35    * Returns default filling color for new 3D polyline.
  36    */
  37   static QColor DefaultFillingColor();
  38
  39   /**
  40    * Returns default border color for new 3D polyline.
  41    */
  42   static QColor DefaultBorderColor();
  43
  44
  45 public:
  46   // Public methods to work with 3D polyline
  47
  48   /**
  49    * Sets reference x,y polyline object for 3D polyline.
  50    */
  51   virtual bool SetPolylineXY( const Handle(HYDROData_PolylineXY)& thePolyline,
  52                               const bool theIsUpdateProfile = true );
  53
  54   /**
  55    * Returns reference x,y polyline object of 3D polyline.
  56    */
  57   virtual Handle(HYDROData_PolylineXY) GetPolylineXY() const;
  58
  59   /**
  60    * Remove reference x,y polyline object from 3D polyline.
  61    */
  62   virtual void RemovePolylineXY();
  63
  64
  65   /**
  66    * Sets reference u,z profile object for 3D polyline.
  67    */
  68   virtual bool SetProfileUZ( const Handle(HYDROData_ProfileUZ)& theProfile );
  69
  70   /**
  71    * Returns reference u,z profile object of 3D polyline.
  72    */
  73   virtual Handle(HYDROData_ProfileUZ) GetProfileUZ() const;
  74
  75   /**
  76    * Remove reference u,z profile object from 3D polyline.
  77    */
  78   virtual void RemoveProfileUZ();
  79
  80
  81   /**
  82    * Set reference bathymetry object for geometry object.
  83    * Reimplemented to remove reference u,z profile.
  84    */
  85   virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );
  86
  87   /**
  88    * Clear the reference bathymetry object for geometry object.
  89    * Reimplemented to remove child u,z profile.
  90    */
  91   virtual void RemoveAltitudeObject();
  92
  93
  94   /**
  95    * Returns the child u,z profile which has been generated from bathymetry.
  96    */
  97   Handle(HYDROData_ProfileUZ) GetChildProfileUZ( const bool theIsCreate = true ) const;
  98
  99
 100 protected:
 101
 102   /**
 103    * Creates new object in the internal data structure. Use higher level objects
 104    * to create objects with real content.
 105    */
 106   HYDROData_Polyline3D();
 107
 108   /**
 109    * Destructs properties of the object and object itself, removes it from the document.
 110    */
 111   virtual ~HYDROData_Polyline3D();
 112 };