X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Zone.h;h=cc19eadd0d2b6c69c867354782d81df1ba4efd2a;hb=c7cf59e092fe050003d1e556715e3ac97acf6bd4;hp=e9ad3ba9c976b0e972a97fe5f3676932cabbf3e0;hpb=5bdd5a07050d0879edb5efdc7e009850a46c64f8;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Zone.h b/src/HYDROData/HYDROData_Zone.h index e9ad3ba9..cc19eadd 100644 --- a/src/HYDROData/HYDROData_Zone.h +++ b/src/HYDROData/HYDROData_Zone.h @@ -1,35 +1,66 @@ +// Copyright (C) 2007-2015 CEA/DEN, EDF R&D, OPEN CASCADE +// +// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef HYDROData_Zone_HeaderFile #define HYDROData_Zone_HeaderFile -#include +#include "HYDROData_Entity.h" +#include "HYDROData_IInterpolator.h" -#include -#include -#include +class Handle(HYDROData_Object); +class Handle(HYDROData_IAltitudeObject); +class TopoDS_Shape; -class Handle(HYDROData_Bathymetry); -class Handle(HYDROData_Polyline); - -DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Object) +DEFINE_STANDARD_HANDLE(HYDROData_Zone, HYDROData_Entity) /**\class HYDROData_Zone * \brief Class that stores/retreives information about the 2d face. */ -class HYDROData_Zone : public HYDROData_Object +class HYDROData_Zone : public HYDROData_Entity { +public: + + // Enumeration of mergin types for conflict altitudes + enum MergeAltitudesType + { + Merge_UNKNOWN, // Undefined + Merge_ZMIN, // The minimum values + Merge_ZMAX, // The maximum values + Merge_Object // Only one altitude will be taken into account + }; + protected: /** * Enumeration of tags corresponding to the persistent object parameters. */ enum DataTag { - DataTag_First = HYDROData_Object::DataTag_First + 100, ///< first tag, to reserve - DataTag_Bathymetry, ///< reference bathymetries - DataTag_Polyline, ///< reference polyline - DataTag_Color ///< color of zone + DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve + DataTag_Shape, ///< reference shape + DataTag_GeometryObject, ///< reference geometry objects + DataTag_MergeType, ///< mergin type of conflict bathymetries + DataTag_MergeAltitude, ///< reference altitude for conflict merge }; public: @@ -38,98 +69,126 @@ public: /** * Returns the kind of this object. Must be redefined in all objects of known type. */ - HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_ZONE;} + HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_ZONE; } + + + /** + * Returns flag indicating that object is updateble or not. + */ + HYDRODATA_EXPORT virtual bool CanBeUpdated() const; + /** - * Dump object to Python script representation. + * Checks that object has 2D presentation. Reimlemented to retun true. */ - HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const; + HYDRODATA_EXPORT virtual bool IsHas2dPrs() const; /** - * Sets color for zone. + * Returns flag indicating that object can be removed or not. */ - HYDRODATA_EXPORT virtual void SetColor( const QColor& theColor ); + HYDRODATA_EXPORT virtual bool CanRemove(); /** - * Returns color of zone. + * Returns the list of all reference objects of this object. */ - HYDRODATA_EXPORT virtual QColor GetColor() const; + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const; /** - * Sets reference polyline object for zone. + * Sets the shape of the zone. */ - HYDRODATA_EXPORT virtual void SetPolyline( const Handle(HYDROData_Polyline)& thePolyline ); + HYDRODATA_EXPORT virtual void SetShape( const TopoDS_Shape& theShape ); /** - * Returns reference polyline object of zone. + * Returns the shape of the zone. */ - HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline) GetPolyline() const; + HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const; + /** - * Remove reference polyline object of zone. + * Returns true if zone needs merge of bathymetries. */ - HYDRODATA_EXPORT virtual void RemovePolyline(); + HYDRODATA_EXPORT virtual bool IsMergingNeed() const; /** - * Returns number of bathymetry objects for zone. + * Sets the interpolator for zone. By default it is NULL and original + * interpolation algorithms are used to calculate points altitudes. + * If you set interpolator it won't be stored in the data model structure, + * it will be deleted during that time as this zone will be freed. */ - HYDRODATA_EXPORT virtual int NbBathymetries() const; + HYDRODATA_EXPORT virtual void SetInterpolator( HYDROData_IInterpolator* theInter ); + + /** + * * Returns the interpolator of zone object. + */ + HYDRODATA_EXPORT virtual HYDROData_IInterpolator* GetInterpolator() const; + /** - * Add reference bathymetry object for zone. + * Sets the merging type for conflict altitudes. + * By default it is set to Merge_UNKNOWN. */ - HYDRODATA_EXPORT virtual void AddBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry ); + HYDRODATA_EXPORT virtual void SetMergeType( const MergeAltitudesType& theType ); /** - * Change reference bathymetry object with given index for zone. + * Returns the merging type for conflict altitudes. */ - HYDRODATA_EXPORT virtual void SetBathymetry( const int theIndex, - const Handle(HYDROData_Bathymetry)& theBathymetry ); + HYDRODATA_EXPORT virtual MergeAltitudesType GetMergeType() const; + /** - * Returns reference bathymetry object of zone by it index. + * Sets the reference altitude to resolve the conflict. + * This object is used only in case of "Merge_Object" merge type. */ - HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetBathymetry( const int theIndex ) const; + HYDRODATA_EXPORT virtual void SetMergeAltitude( const Handle(HYDROData_IAltitudeObject)& theAltitude ); /** - * Returns list of all reference bathymetry objects of zone. + * Returns the reference altitude to resolve the conflict. */ - HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetBathymetries() const; + HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetMergeAltitude() const; /** - * Clear list of bathymetry objects of zone. + * Removes the reference altitude for resolving the conflict. */ - HYDRODATA_EXPORT virtual void RemoveBathymetries(); + HYDRODATA_EXPORT virtual void RemoveMergeAltitude(); + /** - * Returns data of object wrapped to QVariant. - * Reimplemented to wrap and return saved 2d polyline. + * Add new one geometry object for zone. */ - //HYDRODATA_EXPORT virtual QVariant GetDataVariant(); + HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject ); /** - * Returns the painter path. The painter path is construct by polyline + * Returns all geometry objects of zone. */ - HYDRODATA_EXPORT QPainterPath GetPainterPath() const; + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const; + /** + * Removes all geometry objects from zone. + */ + HYDRODATA_EXPORT virtual void RemoveGeometryObjects(); protected: + friend class HYDROData_Region; friend class HYDROData_Iterator; /** * Creates new object in the internal data structure. Use higher level objects * to create objects with real content. */ - HYDROData_Zone(); + HYDRODATA_EXPORT HYDROData_Zone(); /** * Destructs properties of the object and object itself, removes it from the document. */ - ~HYDROData_Zone(); + HYDRODATA_EXPORT ~HYDROData_Zone(); + +private: + HYDROData_IInterpolator* myInterpolator; + }; #endif