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_UNKNOWN, // Undefined
26 Merge_ZMIN, // The minimum values
27 Merge_ZMAX, // The maximum values
28 Merge_Object // Only one bathymetry will be taken into account
33 * Enumeration of tags corresponding to the persistent object parameters.
37 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
38 DataTag_Shape, ///< reference shape
39 DataTag_GeometryObject, ///< reference geometry objects
40 DataTag_MergeType, ///< mergin type of conflict bathymetries
41 DataTag_Bathymetry, ///< reference bathymetry
45 DEFINE_STANDARD_RTTI(HYDROData_Zone);
48 * Returns the kind of this object. Must be redefined in all objects of known type.
50 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_ZONE; }
53 * Dump object to Python script representation.
55 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
59 * Returns flag indicating that object can be removed or not.
61 HYDRODATA_EXPORT virtual bool CanRemove();
64 * Returns the list of all reference objects of this object.
66 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
70 * Sets the shape of the zone.
72 HYDRODATA_EXPORT virtual void SetShape( const TopoDS_Shape& theShape );
75 * Returns the shape of the zone.
77 HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const;
81 * Returns true if zone needs merge of bathymetries.
83 HYDRODATA_EXPORT virtual bool IsMergingNeed() const;
87 * Sets the merging type for conflict bathymetries.
88 * By default it is set to Merge_UNKNOWN.
90 HYDRODATA_EXPORT virtual void SetMergeType( const MergeBathymetriesType& theType );
93 * Returns the merging type for conflict bathymetries.
95 HYDRODATA_EXPORT virtual MergeBathymetriesType GetMergeType() const;
99 * Sets the reference bathymetry to resolve the conflict.
100 * This object is used only in case of "Merge_Object" merge type.
102 HYDRODATA_EXPORT virtual void SetMergeBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry );
105 * Returns the reference bathymetry to resolve the conflict.
107 HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetMergeBathymetry() const;
110 * Removes the reference bathymetry for resolving the conflict.
112 HYDRODATA_EXPORT virtual void RemoveMergeBathymetry();
116 * Add new one geometry object for zone.
118 HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
121 * Returns all geometry objects of zone.
123 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
126 * Removes all geometry objects from zone.
128 HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
133 friend class HYDROData_Region;
134 friend class HYDROData_Iterator;
137 * Creates new object in the internal data structure. Use higher level objects
138 * to create objects with real content.
140 HYDRODATA_EXPORT HYDROData_Zone();
143 * Destructs properties of the object and object itself, removes it from the document.
145 HYDRODATA_EXPORT ~HYDROData_Zone();