src/HYDROPy/HYDROData_Object.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
  24 %ExportedHeaderCode
  25 #include <HYDROData_Object.h>
  26 %End
  27
  28 typedef int ObjectKind;
  29
  30 class HYDROData_Object
  31 {
  32 %TypeHeaderCode
  33 #include <HYDROData_Object.h>
  34 %End
  35
  36 %ConvertToSubClassCode
  37     // HYDROData_Object sub-classes provide a unique kind ID.
  38     switch ( sipCpp->GetKind() )
  39     {
  40       case KIND_BATHYMETRY:
  41         sipClass = sipClass_HYDROData_Bathymetry;
  42         break;
  43
  44       case KIND_UNKNOWN:
  45         sipClass = sipClass_HYDROData_Object;
  46         break;
  47
  48       default:
  49         // We don't recognise the type.
  50         sipClass = NULL;
  51     }
  52 %End
  53
  54 public:
  55   /**
  56    * Visual state data.
  57    */
  58   struct VisualState
  59   {
  60     bool Visibility;
  61     double Transparency;
  62     double ZValue;
  63
  64     VisualState();
  65   };
  66
  67   typedef QMap        < int, HYDROData_Object::VisualState > ViewId2VisualStateMap;
  68   typedef QMapIterator< int, HYDROData_Object::VisualState > ViewId2VisualStateMapIterator;
  69
  70 public:
  71
  72   /**
  73    * Returns the kind of this object. Must be redefined in all objects of known type.
  74    */
  75   //virtual const ObjectKind GetKind() const {return KIND_UNKNOWN;}
  76
  77   /**
  78    * Returns the name of this object.
  79    */
  80   QString GetName() const;
  81
  82   /**
  83    * Updates the name of this object.
  84    */
  85   void SetName(const QString& theName);
  86
  87   /**
  88    * Returns the object visibility state for the view with specified id.
  89    * \param theViewId view id
  90    * \returns visibility state
  91    */
  92   bool IsVisible( const int theViewId ) const;
  93
  94   /**
  95    * Sets the object visibility state for the view with specified id.
  96    * \param theViewId view id
  97    * \param theVal visibility state
  98    */
  99   void SetVisible( const int theViewId,
 100                    const bool theVal );
 101
 102   /**
 103    * Checks is object exists in the data structure.
 104    * \returns true is object is not exists in the data model
 105    */
 106   bool IsRemoved() const;
 107
 108   /**
 109    * Removes object from the data structure.
 110    */
 111   void Remove();
 112
 113   /**
 114    * Returns unique integer identifier of the object (may be used for ordering of objects)
 115    */
 116   int ID() const;
 117
 118   /**
 119    * Copies all properties of this to the destinated object.
 120    * Objects must be the same type.
 121    * \param theDestination initialized object (from any document) - target of copying
 122    */
 123   /*
 124   void CopyTo( HYDROData_Object theDestination ) const;
 125   */
 126
 127 protected:
 128
 129   //friend class HYDROData_Iterator;
 130
 131   /**
 132    * Creates new object in the internal data structure. Use higher level objects
 133    * to create objects with real content.
 134    */
 135   HYDROData_Object();
 136
 137   /**
 138    * Destructs properties of the object and object itself, removes it from the document.
 139    */
 140   virtual ~HYDROData_Object();
 141
 142 };