src/HYDROData/HYDROData_DummyObject3D.h

   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 #ifndef HYDROData_DummyObject3D_HeaderFile
  20 #define HYDROData_DummyObject3D_HeaderFile
  21
  22 #include <HYDROData_Entity.h>
  23
  24 class HYDROData_Object;
  25 class TopoDS_Shape;
  26
  27 /**\class HYDROData_DummyObject3D
  28  * \brief The artificial objects are objects created or planned for creation by human.
  29  *
  30  */
  31 class HYDROData_DummyObject3D : public HYDROData_Entity
  32 {
  33 protected:
  34   /**
  35    * Enumeration of tags corresponding to the persistent object parameters.
  36    */
  37   enum DataTag
  38   {
  39     DataTag_First = HYDROData_Entity::DataTag_First + 100 ///< first tag, to reserve
  40   };
  41
  42 public:
  43   DEFINE_STANDARD_RTTIEXT(HYDROData_DummyObject3D, HYDROData_Entity);
  44
  45 public:
  46
  47   /**
  48    * Returns the kind of this object. Must be redefined in all objects of known type.
  49    */
  50   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_DUMMY_3D; }
  51
  52   /**
  53    * Returns the name of this object.
  54    */
  55   HYDRODATA_EXPORT virtual QString GetName() const;
  56
  57   /**
  58    * Returns flag indicating that object is updateble or not.
  59    */
  60   HYDRODATA_EXPORT virtual bool CanBeUpdated() const;
  61
  62   /**
  63    * Returns flag indicating that object can be removed or not.
  64    */
  65   HYDRODATA_EXPORT virtual bool CanRemove();
  66
  67
  68   /**
  69    * Returns the parent object.
  70    */
  71   HYDRODATA_EXPORT Handle(HYDROData_Object) GetObject() const;
  72
  73   /**
  74    * Returns the 3d shape of the parent object.
  75    */
  76   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
  77
  78
  79   /**
  80    * Returns filling color of object.
  81    */
  82   HYDRODATA_EXPORT virtual QColor GetFillingColor() const;
  83
  84   /**
  85    * Returns border color of object.
  86    */
  87   HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
  88
  89 protected:
  90
  91   friend class HYDROData_Iterator;
  92
  93   /**
  94    * Creates new object in the internal data structure. Use higher level objects
  95    * to create objects with real content.
  96    */
  97   HYDRODATA_EXPORT HYDROData_DummyObject3D();
  98
  99   /**
 100    * Destructs properties of the object and object itself, removes it from the document.
 101    */
 102   virtual HYDRODATA_EXPORT ~HYDROData_DummyObject3D();
 103 };
 104
 105 #endif