Salome HOME
Merging with V7_main branch.
[modules/hydro.git] / src / HYDROPy / HYDROData_Polyline.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_Polyline.h>
25 %End
26
27 class HYDROData_Polyline : HYDROData_Object
28 {
29
30 %TypeHeaderCode
31 #include <HYDROData_Polyline.h>
32 %End
33
34 %ConvertToSubClassCode
35     switch ( sipCpp->GetKind() )
36     {
37       case KIND_POLYLINE:
38         sipClass = sipClass_HYDROData_Polyline;
39         break;
40
41       default:
42         // We don't recognise the type.
43         sipClass = NULL;
44     }
45 %End
46
47 public:      
48
49   /**
50    * Return polyline dimension
51    * \return polyline dimension (2 or 3)
52    */
53   int GetDimension() const;
54
55   /**
56    * Set polyline dimension (2 or 3)
57    * \param theDimension the polyline dimension
58    */
59   void SetDimension( int theDimension );
60
61   /**
62    * Remove all sections from polyline
63    */
64   void RemoveAll();
65
66
67   /**
68    * Returns the painter path. The painter path is construct by lines
69    */
70   QPainterPath GetPainterPath();
71
72
73   /**
74    * Sets the z value for polyline.
75    */
76   void SetZValue( const double theZValue );
77   
78   /**
79    * Returns the z value for polyline.
80    */
81   double ZValue() const;
82
83 protected:
84
85   /**
86    * Creates new object in the internal data structure. Use higher level objects 
87    * to create objects with real content.
88    */
89   HYDROData_Polyline();
90
91   /**
92    * Destructs properties of the object and object itself, removes it from the document.
93    */
94   ~HYDROData_Polyline();
95 };
96
97