src/HYDROPy/HYDROData_Object.sip

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 %ExportedHeaderCode
  20 #include <HYDROData_Object.h>
  21 %End
  22
  23 class HYDROData_Object : public HYDROData_Entity /Abstract/
  24 {
  25 %TypeHeaderCode
  26 #include <HYDROData_Object.h>
  27 %End
  28
  29 %ConvertToSubClassCode
  30    // HYDROData_Object sub-classes provide a unique kind ID.
  31   switch ( sipCpp->GetKind() )
  32   {
  33     case KIND_OBSTACLE:
  34       sipClass = sipClass_HYDROData_Obstacle;
  35       break;
  36
  37     case KIND_CONFLUENCE:
  38       sipClass = sipClass_HYDROData_Confluence;
  39       break;
  40
  41     case KIND_IMMERSIBLE_ZONE:
  42       sipClass = sipClass_HYDROData_ImmersibleZone;
  43       break;
  44
  45     case KIND_DIGUE:
  46       sipClass = sipClass_HYDROData_Digue;
  47       break;
  48
  49     case KIND_CHANNEL:
  50       sipClass = sipClass_HYDROData_Channel;
  51       break;
  52
  53     case KIND_POLYLINE:
  54       sipClass = sipClass_HYDROData_Polyline3D;
  55       break;
  56
  57     case KIND_PROFILE:
  58       sipClass = sipClass_HYDROData_Profile;
  59       break;
  60
  61     case KIND_STREAM:
  62       sipClass = sipClass_HYDROData_Stream;
  63       break;
  64
  65     case KIND_BC_POLYGON:
  66       sipClass = sipClass_HYDROData_BCPolygon;
  67       break;
  68
  69     case KIND_UNKNOWN:
  70       sipClass = sipClass_HYDROData_Entity;
  71       break;
  72
  73     default:
  74       // We don't recognise the type.
  75       sipClass = NULL;
  76   }
  77 %End
  78
  79 public:
  80
  81   /**
  82    * Set reference altitude object for geometry object.
  83    */
  84   bool SetAltitudeObject( HYDROData_IAltitudeObject theAltitude ) [void (const opencascade::handle<HYDROData_IAltitudeObject>&)];
  85   %MethodCode
  86
  87     Handle(HYDROData_IAltitudeObject) aRefAltitude =
  88       Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
  89     if ( !aRefAltitude.IsNull() )
  90     {
  91       Py_BEGIN_ALLOW_THREADS
  92       sipRes = sipSelfWasArg ? sipCpp->HYDROData_Object::SetAltitudeObject( aRefAltitude ) :
  93                                sipCpp->SetAltitudeObject( aRefAltitude );
  94       Py_END_ALLOW_THREADS
  95     }
  96
  97   %End
  98
  99   /**
 100    * Returns reference altitude object of geometry object.
 101    */
 102   HYDROData_IAltitudeObject GetAltitudeObject() const [opencascade::handle<HYDROData_IAltitudeObject> ()];
 103   %MethodCode
 104
 105     Handle(HYDROData_IAltitudeObject) aRefAltitude;
 106
 107     Py_BEGIN_ALLOW_THREADS
 108     aRefAltitude = sipSelfWasArg ? sipCpp->HYDROData_Object::GetAltitudeObject() :
 109                                    sipCpp->GetAltitudeObject();
 110     Py_END_ALLOW_THREADS
 111
 112     sipRes = (HYDROData_IAltitudeObject*)createPointer( aRefAltitude );
 113
 114   %End
 115
 116   /**
 117    * Clear the reference altitude object for geometry object.
 118    */
 119   void RemoveAltitudeObject();
 120
 121   /**
 122    * Sets filling color for zone.
 123    */
 124   virtual void SetFillingColor( const QColor& theColor );
 125
 126   /**
 127    * Returns filling color of zone.
 128    */
 129   virtual QColor GetFillingColor() const;
 130
 131   /**
 132    * Sets border color for zone.
 133    */
 134   virtual void SetBorderColor( const QColor& theColor );
 135
 136   /**
 137    * Returns border color of zone.
 138    */
 139   virtual QColor GetBorderColor() const;
 140
 141
 142   /**
 143    * Returns sequence of object groups.
 144    */
 145   HYDROData_SequenceOfObjects GetGroups() const;
 146
 147   /**
 148    * Returns group data model object by it id.
 149    */
 150   HYDROData_ShapesGroup GetGroup( const int theGroupId ) const [opencascade::handle<HYDROData_ShapesGroup> ()];
 151   %MethodCode
 152
 153     Handle(HYDROData_ShapesGroup) aRefGroup;
 154
 155     Py_BEGIN_ALLOW_THREADS
 156     aRefGroup = sipSelfWasArg ? sipCpp->HYDROData_Object::GetGroup( a0 ) :
 157                                 sipCpp->GetGroup( a0 );
 158     Py_END_ALLOW_THREADS
 159
 160     sipRes = (HYDROData_ShapesGroup*)createPointer( aRefGroup );
 161
 162   %End
 163
 164   /**
 165    * Returns group id by data model object.
 166    */
 167   int GetGroupId( HYDROData_ShapesGroup theGroup ) const [int (const opencascade::handle<HYDROData_ShapesGroup>&)];
 168   %MethodCode
 169
 170     Handle(HYDROData_ShapesGroup) aRefGroup =
 171       Handle(HYDROData_ShapesGroup)::DownCast( createHandle( a0 ) );
 172     if ( !aRefGroup.IsNull() )
 173     {
 174       Py_BEGIN_ALLOW_THREADS
 175       sipRes = sipSelfWasArg ? sipCpp->HYDROData_Object::GetGroupId( aRefGroup ) :
 176                                sipCpp->GetGroupId( aRefGroup );
 177       Py_END_ALLOW_THREADS
 178     }
 179
 180   %End
 181
 182   void SetIsSubmersible( bool ) const;
 183
 184 protected:
 185
 186   /**
 187    * Creates new object in the internal data structure. Use higher level objects
 188    * to create objects with real content.
 189    */
 190   HYDROData_Object();
 191
 192   /**
 193    * Destructs properties of the object and object itself, removes it from the document.
 194    */
 195   virtual ~HYDROData_Object();
 196
 197 };