src/HYDROPy/HYDROData_Object.sip

   1 // Copyright (C) 2007-2015  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, or (at your option) any later version.
  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_Object.h>
  25 %End
  26
  27 class HYDROData_Object : public HYDROData_Entity /Abstract/
  28 {
  29 %TypeHeaderCode
  30 #include <HYDROData_Object.h>
  31 %End
  32
  33 %ConvertToSubClassCode
  34    // HYDROData_Object sub-classes provide a unique kind ID.
  35   switch ( sipCpp->GetKind() )
  36   {
  37     case KIND_OBSTACLE:
  38       sipClass = sipClass_HYDROData_Obstacle;
  39       break;
  40
  41     case KIND_CONFLUENCE:
  42       sipClass = sipClass_HYDROData_Confluence;
  43       break;
  44
  45     case KIND_IMMERSIBLE_ZONE:
  46       sipClass = sipClass_HYDROData_ImmersibleZone;
  47       break;
  48
  49     case KIND_DIGUE:
  50       sipClass = sipClass_HYDROData_Digue;
  51       break;
  52
  53     case KIND_CHANNEL:
  54       sipClass = sipClass_HYDROData_Channel;
  55       break;
  56
  57     case KIND_POLYLINE:
  58       sipClass = sipClass_HYDROData_Polyline3D;
  59       break;
  60
  61     case KIND_PROFILE:
  62       sipClass = sipClass_HYDROData_Profile;
  63       break;
  64
  65     case KIND_STREAM:
  66       sipClass = sipClass_HYDROData_Stream;
  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 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 [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 [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 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
 183 protected:
 184
 185   /**
 186    * Creates new object in the internal data structure. Use higher level objects
 187    * to create objects with real content.
 188    */
 189   HYDROData_Object();
 190
 191   /**
 192    * Destructs properties of the object and object itself, removes it from the document.
 193    */
 194   virtual ~HYDROData_Object();
 195
 196 };