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