X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Zone.h;h=cde3b789a8f0a2a7facef4709c4ea50a23d2e982;hb=9301cf6c824faaa2edf66b40f820e415b7021759;hp=5b277a13095b3474265b17b2176acffb320674d8;hpb=38afdfd781e77ef1d5135bed210c8ebd4b60f34f;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Zone.h b/src/HYDROData/HYDROData_Zone.h index 5b277a13..cde3b789 100644 --- a/src/HYDROData/HYDROData_Zone.h +++ b/src/HYDROData/HYDROData_Zone.h @@ -1,36 +1,61 @@ +// Copyright (C) 2014-2015 EDF-R&D +// 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_LandCover); +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/types + enum MergeType + { + Merge_UNKNOWN, // Undefined + Merge_ZMIN, // The minimum values + Merge_ZMAX, // The maximum values + Merge_Object // Only one altitude/land cover 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_FillingColor, ///< filling color of zone - DataTag_BorderColor, ///< border color of zone + DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve + DataTag_Shape, ///< reference shape + DataTag_Object, ///< reference objects + DataTag_MergeType, ///< mergin type of conflict bathymetries/types + DataTag_MergeObject, ///< reference altitude/land cover for conflict merge }; public: @@ -39,119 +64,134 @@ 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; } + /** - * Dump object to Python script representation. + * Returns flag indicating that object is updateble or not. */ - HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const; + HYDRODATA_EXPORT virtual bool CanBeUpdated() const; /** - * Returns default filling color for new zone. + * Checks that object has 2D presentation. Reimlemented to retun true. */ - HYDRODATA_EXPORT static QColor DefaultFillingColor(); + HYDRODATA_EXPORT virtual bool IsHas2dPrs() const; + /** - * Sets filling color for zone. + * Returns flag indicating that object can be removed or not. */ - HYDRODATA_EXPORT virtual void SetFillingColor( const QColor& theColor ); + HYDRODATA_EXPORT virtual bool CanRemove(); /** - * Returns filling color of zone. + * Returns the list of all reference objects of this object. */ - HYDRODATA_EXPORT virtual QColor GetFillingColor() const; + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const; /** - * Returns default border color for new zone. + * Sets the shape of the zone. */ - HYDRODATA_EXPORT static QColor DefaultBorderColor(); + HYDRODATA_EXPORT virtual void SetShape( const TopoDS_Shape& theShape ); /** - * Sets border color for zone. + * Returns the shape of the zone. */ - HYDRODATA_EXPORT virtual void SetBorderColor( const QColor& theColor ); + HYDRODATA_EXPORT virtual TopoDS_Shape GetShape() const; + /** - * Returns border color of zone. + * Returns true if zone needs merge of bathymetries. */ - HYDRODATA_EXPORT virtual QColor GetBorderColor() const; + HYDRODATA_EXPORT virtual bool IsMergingNeed() const; /** - * Sets reference polyline object 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 void SetPolyline( const Handle(HYDROData_Polyline)& thePolyline ); + HYDRODATA_EXPORT virtual void SetInterpolator( HYDROData_IInterpolator* theInter ); /** - * Returns reference polyline object of zone. + * * Returns the interpolator of zone object. */ - HYDRODATA_EXPORT virtual Handle(HYDROData_Polyline) GetPolyline() const; - + HYDRODATA_EXPORT virtual HYDROData_IInterpolator* GetInterpolator() const; + /** - * Remove reference polyline object of zone. + * Sets the merging type for conflict altitudes. + * By default it is set to Merge_UNKNOWN. */ - HYDRODATA_EXPORT virtual void RemovePolyline(); - + HYDRODATA_EXPORT virtual void SetMergeType( const MergeType& theType ); /** - * Returns number of bathymetry objects for zone. + * Returns the merging type for conflict altitudes/types. */ - HYDRODATA_EXPORT virtual int NbBathymetries() const; + HYDRODATA_EXPORT virtual MergeType GetMergeType() const; + /** - * Add reference bathymetry object for zone. + * Sets the reference object to resolve the conflict. + * This object is used only in case of "Merge_Object" merge type. + * \param theObject the merge object */ - HYDRODATA_EXPORT virtual void AddBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry ); + HYDRODATA_EXPORT virtual void SetMergeObject( const Handle(HYDROData_Entity)& theObject ); /** - * Change reference bathymetry object with given index for zone. + * Returns the reference object to resolve the conflict. + * \return the merge object */ - HYDRODATA_EXPORT virtual void SetBathymetry( const int theIndex, - const Handle(HYDROData_Bathymetry)& theBathymetry ); + HYDRODATA_EXPORT virtual Handle(HYDROData_Entity) GetMergeObject() const; /** - * Returns reference bathymetry object of zone by it index. + * Removes the reference object for resolving the conflict. */ - HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetBathymetry( const int theIndex ) const; - + HYDRODATA_EXPORT virtual void RemoveMergeObject(); + /** - * Returns list of all reference bathymetry objects of zone. + * Add new one object for zone. + * \param theObject the object to add */ - HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetBathymetries() const; + HYDRODATA_EXPORT virtual bool AddObject( const Handle(HYDROData_Entity)& theObject ); /** - * Clear list of bathymetry objects of zone. + * Returns all objects of zone. + * \return the list of objects */ - HYDRODATA_EXPORT virtual void RemoveBathymetries(); + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetObjects() const; /** - * Returns data of object wrapped to QVariant. - * Reimplemented to wrap and return saved 2d polyline. + * Removes all objects from zone. */ - //HYDRODATA_EXPORT virtual QVariant GetDataVariant(); + HYDRODATA_EXPORT virtual void RemoveObjects(); /** - * Returns the painter path. The painter path is construct by polyline + * Returns submersible flag. + * \return true if all objects of the zone is submersible */ - HYDRODATA_EXPORT QPainterPath GetPainterPath() const; - + HYDRODATA_EXPORT bool IsSubmersible() const; 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