2 #ifndef HYDROData_Zone_HeaderFile
3 #define HYDROData_Zone_HeaderFile
5 #include <HYDROData_Entity.h>
7 class Handle(HYDROData_Object);
8 class Handle(HYDROData_Bathymetry);
11 DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity)
14 /**\class HYDROData_Zone
15 * \brief Class that stores/retreives information about the 2d face.
17 class HYDROData_Zone : public HYDROData_Entity
22 // Enumeration of mergin types for conflict bathymetries
23 enum MergeBathymetriesType
25 Merge_ZMIN, // The minimum values
26 Merge_ZMAX, // The maximum values
27 Merge_Object // Only one bathymetry will be taken into account
32 * Enumeration of tags corresponding to the persistent object parameters.
36 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
37 DataTag_Shape, ///< reference shape
38 DataTag_GeometryObject, ///< reference geometry objects
39 DataTag_MergeType, ///< mergin type of conflict bathymetries
40 DataTag_Bathymetry, ///< reference bathymetry
44 DEFINE_STANDARD_RTTI(HYDROData_Zone);
47 * Returns the kind of this object. Must be redefined in all objects of known type.
49 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_ZONE; }
52 * Dump object to Python script representation.
54 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
58 * Sets the shape of the zone.
60 HYDRODATA_EXPORT virtual void SetShape( const TopoDS_Shape& theShape );
63 * Returns the shape of the zone.
65 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
69 * Sets the merging type for conflict bathymetries.
70 * By default it is set to Merge_ZMIN.
72 HYDRODATA_EXPORT virtual void SetMergeType( const MergeBathymetriesType& theType );
75 * Returns the merging type for conflict bathymetries.
77 HYDRODATA_EXPORT virtual MergeBathymetriesType GetMergeType() const;
81 * Sets the reference bathymetry to resolve the conflict.
82 * This object is used only in case of "Merge_Object" merge type.
84 HYDRODATA_EXPORT virtual void SetMergeBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry );
87 * Returns the reference bathymetry to resolve the conflict.
89 HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetMergeBathymetry() const;
92 * Removes the reference bathymetry for resolving the conflict.
94 HYDRODATA_EXPORT virtual void RemoveMergeBathymetry();
98 * Add new one geometry object for zone.
100 HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
103 * Returns all geometry objects of zone.
105 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
108 * Removes all geometry objects from zone.
110 HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
115 friend class HYDROData_Region;
116 friend class HYDROData_Iterator;
119 * Creates new object in the internal data structure. Use higher level objects
120 * to create objects with real content.
125 * Destructs properties of the object and object itself, removes it from the document.