Salome HOME
Python API for HYDROData_Polyline. Plus some minor changes.
[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 struct PolylineSection
28 {
29 %TypeHeaderCode
30 #include <HYDROData_Polyline.h>
31 %End
32
33   enum SectionType{ SECTION_POLYLINE = 0, SECTION_SPLINE = 1 };
34
35   PolylineSection();
36   
37   SectionType                 myType;
38   bool                        myIsClosed;
39   QList<double>               myCoords;
40
41   QString                     mySectionName
42   {
43     %GetCode
44         sipPy = PyString_FromString( TCollection_AsciiString( sipCpp->mySectionName ).ToCString() );
45     %End
46
47     %SetCode
48         char* ptr;
49
50         if ( ( ptr = PyString_AsString( sipPy ) ) == NULL )
51         {
52           sipErr = 1;
53         }
54         else
55         {
56           sipCpp->mySectionName = TCollection_ExtendedString( ptr );
57         }
58     %End
59   };
60 };
61
62 class HYDROData_Polyline : HYDROData_Object
63 {
64
65 %ConvertToSubClassCode
66     if ( !Handle(HYDROData_Polyline)::DownCast( sipCpp ).IsNull() )
67       sipClass = sipClass_HYDROData_Polyline;
68     else
69       sipClass = NULL;
70 %End
71
72 public:
73
74   const ObjectKind          GetKind() const;
75
76 public:      
77
78   /**
79    * Replace current polyline data by new sections list
80    * \param theSections the sections list
81    */
82   void setPolylineData( const QList<PolylineSection>& theSections );
83
84   /**
85    * Return polyline data
86    * \return polyline section list
87    */
88   QList<PolylineSection> getPolylineData();
89    
90   /**
91    * Return polyline dimension
92    * \return polyline dimension (2 or 3)
93    */
94   int getDimension() const;
95
96   /**
97    * Set polyline dimension (2 or 3)
98    * \param theDimension the polyline dimension
99    */
100   void setDimension( int theDimension );
101
102   /**
103    * Remove all sections from polyline
104    */
105   void removeAll();
106
107
108   /**
109    * Returns the painter path. The painter path is construct by lines
110    */
111   QPainterPath painterPath();
112
113 protected:
114
115   /**
116    * Creates new object in the internal data structure. Use higher level objects 
117    * to create objects with real content.
118    */
119   HYDROData_Polyline();
120
121   /**
122    * Destructs properties of the object and object itself, removes it from the document.
123    */
124   ~HYDROData_Polyline();
125 };
126
127