src/HYDROData/HYDROData_Obstacle.h

   1
   2 #ifndef HYDROData_Obstacle_HeaderFile
   3 #define HYDROData_Obstacle_HeaderFile
   4
   5 #include "HYDROData_ArtificialObject.h"
   6
   7 DEFINE_STANDARD_HANDLE(HYDROData_Obstacle, HYDROData_ArtificialObject)
   8
   9 /**\class HYDROData_Obstacle
  10  * \brief
  11  *
  12  */
  13 class HYDROData_Obstacle : public HYDROData_ArtificialObject
  14 {
  15 protected:
  16   /**
  17    * Enumeration of tags corresponding to the persistent object parameters.
  18    */
  19   enum DataTag
  20   {
  21     DataTag_First = HYDROData_ArtificialObject::DataTag_First + 100, ///< first tag, to reserve
  22   };
  23
  24 public:
  25   DEFINE_STANDARD_RTTI(HYDROData_Obstacle);
  26
  27   /**
  28    * Returns the kind of this object. Must be redefined in all objects of known type.
  29    */
  30   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_OBSTACLE;}
  31
  32   /**
  33    * Dump object to Python script representation.
  34    */
  35   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  36
  37   /**
  38    * Returns the top shape of the object.
  39    */
  40   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
  41
  42   /**
  43    * Returns the 3d shape of the object.
  44    */
  45   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
  46
  47 protected:
  48
  49   friend class HYDROData_Iterator;
  50
  51   /**
  52    * Creates new object in the internal data structure. Use higher level objects
  53    * to create objects with real content.
  54    */
  55   HYDRODATA_EXPORT HYDROData_Obstacle();
  56
  57   /**
  58    * Destructs properties of the object and object itself, removes it from the document.
  59    */
  60   virtual HYDRODATA_EXPORT ~HYDROData_Obstacle();
  61 };
  62
  63 #endif