src/HYDROData/HYDROData_DummyObject3D.h

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