X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Object.h;h=302f5580e813fe8b45b2712cc2a79fc383f47da0;hb=81c9f5cdf82909d0aebd2c491c50fa7516cc80b7;hp=594bbd60e0dc65c8a0f2b06ef3ed7fc0660d3b08;hpb=d5ab854432d2b0ec5a504b7f5bbf67d12bec472a;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Object.h b/src/HYDROData/HYDROData_Object.h index 594bbd60..302f5580 100644 --- a/src/HYDROData/HYDROData_Object.h +++ b/src/HYDROData/HYDROData_Object.h @@ -4,11 +4,13 @@ #include -class TopoDS_Shape; DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity) -class Handle(HYDROData_Bathymetry); +class TopoDS_Shape; +class Handle(HYDROData_IAltitudeObject); +class Handle(HYDROData_DummyObject3D); +class Handle(HYDROData_ShapesGroup); /**\class HYDROData_Object * \brief The base class for all geometrical objects in the HYDRO module. @@ -25,14 +27,41 @@ protected: 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 + DataTag_AltitudeObject, ///< reference altitude object + DataTag_FillingColor, ///< filling color of geometrical object + DataTag_BorderColor, ///< border color of geometrical object + DataTag_Object3D, ///< child 3D object + DataTag_EdgesGroup, ///< child group objects + DataTag_ChildAltitudeObject, ///< child altitude object }; public: DEFINE_STANDARD_RTTI(HYDROData_Object); + /** + * Updates the name of this object. + * Reimplemented to update the names child groups. + */ + HYDRODATA_EXPORT virtual void SetName( const QString& theName ); + + /** + * Update the geometry object. + * Call this method whenever you made changes for object data. + */ + HYDRODATA_EXPORT virtual void Update(); + + /** + * Returns the list of all reference objects of this object. + */ + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const; + + /** + * Sets the "MustBeUpdated" flag: if object is depended on updated features. + * Reimplemented to update the state of child 3D object. + */ + HYDRODATA_EXPORT virtual void SetToUpdate( bool theFlag ); + + /** * Sets the top(2d projection) shape of the object. */ @@ -55,19 +84,42 @@ public: /** - * Set reference bathymetry object for geometry object. + * Returns reference object which represent the 3D shape of object. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_DummyObject3D) GetObject3D() const; + + + /** + * Returns sequence of object groups. + */ + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGroups() const; + + /** + * Returns group data model object by it id. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) GetGroup( const int theGroupId ) const; + + /** + * Returns group id by data model object. + */ + HYDRODATA_EXPORT virtual int GetGroupId( const Handle(HYDROData_ShapesGroup)& theGroup ) const; + + + /** + * Set reference altitude object for geometry object. */ - HYDRODATA_EXPORT virtual void SetBathymetry( const Handle(HYDROData_Bathymetry)& theBathymetry ); + HYDRODATA_EXPORT virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude ); /** - * Returns reference bathymetry object of geometry object. + * Returns reference altitude object of geometry object. */ - HYDRODATA_EXPORT virtual Handle(HYDROData_Bathymetry) GetBathymetry() const; + HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetAltitudeObject() const; /** - * Clear the reference bathymetry object for geometry object. + * Clear the reference altitude object for geometry object. */ - HYDRODATA_EXPORT virtual void RemoveBathymetry(); + HYDRODATA_EXPORT virtual void RemoveAltitudeObject(); + /** * Sets filling color for object. @@ -89,15 +141,17 @@ public: */ HYDRODATA_EXPORT virtual QColor GetBorderColor() const; +protected: + /** * Returns default filling color for new object. */ - HYDRODATA_EXPORT static QColor DefaultFillingColor(); + HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const; /** * Returns default border color for new object. */ - HYDRODATA_EXPORT static QColor DefaultBorderColor(); + HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const; protected: @@ -114,16 +168,72 @@ protected: protected: + /** + * Dump the initial object creation to a Python script. + * Reimplemented to dump the object colors. + */ + HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const; + + + /** + * Checks and if necessary create child 3D object. + * Reimplement this function in your subclass if you + * do not want to create child 3D object. + */ + HYDRODATA_EXPORT virtual void checkAndSetObject3D(); + + + /** + * Returns the type of child altitude object. + * Base implementation returns KIND_UNKNOWN, it means that child altitude + * object will not be created inside of checkAndSetAltitudeObject() function. + * Reimplement this function in your subclass an return correct altitude + * object type if you want to create child altitude object. + */ + HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const; + + /** + * Checks and if necessary create child altitude object. + */ + HYDRODATA_EXPORT virtual void checkAndSetAltitudeObject(); + + /** + * Return the child altitude object. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) getChildAltitudeObject() const; + + + /** + * Create new one child group object. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject(); + + /** + * Remove all child group objects. + */ + HYDRODATA_EXPORT virtual void removeGroupObjects(); + + /** * Retrieve the top shape of the object from data label. */ HYDRODATA_EXPORT TopoDS_Shape getTopShape() const; + /** + * Removes the top shape from data label of the object. + */ + HYDRODATA_EXPORT void removeTopShape(); + + /** * Retrieve the 3d shape of the object from data label. */ HYDRODATA_EXPORT TopoDS_Shape getShape3D() const; + /** + * Removes the 3d shape from data label of the object. + */ + HYDRODATA_EXPORT void removeShape3D(); }; #endif