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_UNKNOWN:
  66       sipClass = sipClass_HYDROData_Entity;
  67       break;
  68
  69     default:
  70       // We don't recognise the type.
  71       sipClass = NULL;
  72   }
  73 %End
  74
  75 public:
  76
  77   /**
  78    * Set reference altitude object for geometry object.
  79    */
  80   bool SetAltitudeObject( HYDROData_IAltitudeObject theAltitude ) [void (const opencascade::handle<HYDROData_IAltitudeObject>&)];
  81   %MethodCode
  82
  83     Handle(HYDROData_IAltitudeObject) aRefAltitude =
  84       Handle(HYDROData_IAltitudeObject)::DownCast( createHandle( a0 ) );
  85     if ( !aRefAltitude.IsNull() )
  86     {
  87       Py_BEGIN_ALLOW_THREADS
  88       sipRes = sipSelfWasArg ? sipCpp->HYDROData_Object::SetAltitudeObject( aRefAltitude ) :
  89                                sipCpp->SetAltitudeObject( aRefAltitude );
  90       Py_END_ALLOW_THREADS
  91     }
  92
  93   %End
  94
  95   /**
  96    * Returns reference altitude object of geometry object.
  97    */
  98   HYDROData_IAltitudeObject GetAltitudeObject() const [opencascade::handle<HYDROData_IAltitudeObject> ()];
  99   %MethodCode
 100
 101     Handle(HYDROData_IAltitudeObject) aRefAltitude;
 102
 103     Py_BEGIN_ALLOW_THREADS
 104     aRefAltitude = sipSelfWasArg ? sipCpp->HYDROData_Object::GetAltitudeObject() :
 105                                    sipCpp->GetAltitudeObject();
 106     Py_END_ALLOW_THREADS
 107
 108     sipRes = (HYDROData_IAltitudeObject*)createPointer( aRefAltitude );
 109
 110   %End
 111
 112   /**
 113    * Clear the reference altitude object for geometry object.
 114    */
 115   void RemoveAltitudeObject();
 116
 117   /**
 118    * Sets filling color for zone.
 119    */
 120   virtual void SetFillingColor( const QColor& theColor );
 121
 122   /**
 123    * Returns filling color of zone.
 124    */
 125   virtual QColor GetFillingColor() const;
 126
 127   /**
 128    * Sets border color for zone.
 129    */
 130   virtual void SetBorderColor( const QColor& theColor );
 131
 132   /**
 133    * Returns border color of zone.
 134    */
 135   virtual QColor GetBorderColor() const;
 136
 137
 138   /**
 139    * Returns sequence of object groups.
 140    */
 141   HYDROData_SequenceOfObjects GetGroups() const;
 142
 143   /**
 144    * Returns group data model object by it id.
 145    */
 146   HYDROData_ShapesGroup GetGroup( const int theGroupId ) const [opencascade::handle<HYDROData_ShapesGroup> ()];
 147   %MethodCode
 148
 149     Handle(HYDROData_ShapesGroup) aRefGroup;
 150
 151     Py_BEGIN_ALLOW_THREADS
 152     aRefGroup = sipSelfWasArg ? sipCpp->HYDROData_Object::GetGroup( a0 ) :
 153                                 sipCpp->GetGroup( a0 );
 154     Py_END_ALLOW_THREADS
 155
 156     sipRes = (HYDROData_ShapesGroup*)createPointer( aRefGroup );
 157
 158   %End
 159
 160   /**
 161    * Returns group id by data model object.
 162    */
 163   int GetGroupId( HYDROData_ShapesGroup theGroup ) const [int (const opencascade::handle<HYDROData_ShapesGroup>&)];
 164   %MethodCode
 165
 166     Handle(HYDROData_ShapesGroup) aRefGroup =
 167       Handle(HYDROData_ShapesGroup)::DownCast( createHandle( a0 ) );
 168     if ( !aRefGroup.IsNull() )
 169     {
 170       Py_BEGIN_ALLOW_THREADS
 171       sipRes = sipSelfWasArg ? sipCpp->HYDROData_Object::GetGroupId( aRefGroup ) :
 172                                sipCpp->GetGroupId( aRefGroup );
 173       Py_END_ALLOW_THREADS
 174     }
 175
 176   %End
 177
 178   void SetIsSubmersible( bool ) const;
 179
 180 protected:
 181
 182   /**
 183    * Creates new object in the internal data structure. Use higher level objects
 184    * to create objects with real content.
 185    */
 186   HYDROData_Object();
 187
 188   /**
 189    * Destructs properties of the object and object itself, removes it from the document.
 190    */
 191   virtual ~HYDROData_Object();
 192
 193 };