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