X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Object.h;h=594bbd60e0dc65c8a0f2b06ef3ed7fc0660d3b08;hb=deed826b2d6c39ba2ed410108cdf54d64cded321;hp=4f2ae435e1570f20557053379f822131c98c1a70;hpb=2d3a78deaed27c428589ef3474c1c346324962f2;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Object.h b/src/HYDROData/HYDROData_Object.h index 4f2ae435..594bbd60 100644 --- a/src/HYDROData/HYDROData_Object.h +++ b/src/HYDROData/HYDROData_Object.h @@ -1,34 +1,20 @@ + #ifndef HYDROData_Object_HeaderFile #define HYDROData_Object_HeaderFile -#include - -#include -#include -#include +#include -class QString; -class QStringList; +class TopoDS_Shape; -///! Kind of an object in a document -typedef int ObjectKind; -///! Unrecognized object -const ObjectKind KIND_UNKNOWN = 0; -const ObjectKind KIND_IMAGE = 1; -const ObjectKind KIND_POLYLINE = 2; -const ObjectKind KIND_VISUAL_STATE = 3; -const ObjectKind KIND_BATHYMETRY = 4; +DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity) -DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared) +class Handle(HYDROData_Bathymetry); /**\class HYDROData_Object - * \brief Generic class of any object in the data model. + * \brief The base class for all geometrical objects in the HYDRO module. * - * Interface for getting access to the object that belong to the data model. - * Managed by Document. Provides access to the common properties: - * kind of an object, name. */ -class HYDROData_Object : public MMgt_TShared +class HYDROData_Object : public HYDROData_Entity { protected: /** @@ -36,67 +22,84 @@ protected: */ enum DataTag { - DataTag_First = 0 ///< first tag, to reserve - // ... + DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve + DataTag_TopShape, + DataTag_Shape3D, + DataTag_Bathymetry, ///< reference bathymetry + DataTag_FillingColor, ///< filling color of geometrical object + DataTag_BorderColor ///< border color of geometrical object }; public: DEFINE_STANDARD_RTTI(HYDROData_Object); /** - * Returns the kind of this object. Must be redefined in all objects of known type. + * Sets the top(2d projection) shape of the object. */ - HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_UNKNOWN;} + HYDRODATA_EXPORT virtual void SetTopShape( const TopoDS_Shape& theShape ); /** - * Returns the name of this object. + * Returns the top shape of the object. */ - HYDRODATA_EXPORT QString GetName() const; + HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const = 0; /** - * Updates the name of this object. + * Sets the 3d shape of the object. */ - HYDRODATA_EXPORT void SetName(const QString& theName); + HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape ); /** - * Dump object to Python script representation. - * Base implementation returns empty list, - * You should reimplement this function in your derived class if it - * has Python API and can be imported/exported from/to Python script. + * Returns the 3d shape of the object. */ - HYDRODATA_EXPORT virtual QStringList DumpToPython() const; + HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const = 0; + /** - * Checks is object exists in the data structure. - * \returns true is object is not exists in the data model + * Set reference bathymetry object for geometry object. */ - HYDRODATA_EXPORT bool IsRemoved() const; + HYDRODATA_EXPORT virtual void SetBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry ); /** - * Removes object from the data structure. + * Returns reference bathymetry object of geometry object. */ - HYDRODATA_EXPORT void Remove(); + HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetBathymetry() const; /** - * Returns unique integer identifier of the object (may be used for ordering of objects) + * Clear the reference bathymetry object for geometry object. */ - HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();} + HYDRODATA_EXPORT virtual void RemoveBathymetry(); + + /** + * Sets filling color for object. + */ + HYDRODATA_EXPORT virtual void SetFillingColor( const QColor& theColor ); /** - * Copies all properties of this to the destinated object. - * Objects must be the same type. - * \param theDestination initialized object (from any document) - target of copying + * Returns filling color of object. + */ + HYDRODATA_EXPORT virtual QColor GetFillingColor() const; + + /** + * Sets border color for object. */ - HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Object theDestination) const; + HYDRODATA_EXPORT virtual void SetBorderColor( const QColor& theColor ); /** - * Returns the label of this object. + * Returns border color of object. */ - HYDRODATA_EXPORT TDF_Label& Label() {return myLab;} + HYDRODATA_EXPORT virtual QColor GetBorderColor() const; -protected: + /** + * Returns default filling color for new object. + */ + HYDRODATA_EXPORT static QColor DefaultFillingColor(); - friend class HYDROData_Iterator; + /** + * Returns default border color for new object. + */ + HYDRODATA_EXPORT static QColor DefaultBorderColor(); + +protected: /** * Creates new object in the internal data structure. Use higher level objects @@ -109,37 +112,18 @@ protected: */ virtual HYDRODATA_EXPORT ~HYDROData_Object(); - /** - * Put the object to the label of the document. - * \param theLabel new label of the object - */ - HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel); +protected: /** - * Internal method that used to store the byte array attribute - * \param theTag tag of a label to store attribute (for 0 this is myLab) - * \param theData pointer to bytes array - * \param theLen number of bytes in byte array that must be stored + * Retrieve the top shape of the object from data label. */ - void SaveByteArray(const int theTag, const char* theData, const int theLen); + HYDRODATA_EXPORT TopoDS_Shape getTopShape() const; /** - * Internal method that used to retreive the content of byte array attribute - * \param theTag tag of a label that keeps the attribute (for 0 this is myLab) - * \param theLen number of bytes in byte array - * \returns pointer to the internal data structure wit harray content, - * or NULL if array size is zero + * Retrieve the 3d shape of the object from data label. */ - const char* ByteArray(const int theTag, int& theLen); + HYDRODATA_EXPORT TopoDS_Shape getShape3D() const; -protected: - /// Array of pointers to the properties of this object; index in this array is returned by \a AddProperty. - TDF_Label myLab; ///< label of this object }; -typedef NCollection_Sequence HYDROData_SequenceOfObjects; - -///! Is Equal for HYDROData_Object mapping -HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Object& theObj1, const Handle_HYDROData_Object& theObj2); - #endif