X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FHYDROData%2FHYDROData_Object.h;h=0c217f274a6464e8e44d93c5271e4c7de578453b;hb=a95289fabbb6fbf6f32c06207422c65aafd5bd65;hp=e8669db7fecd44428e47d65c15836e6156acc8d2;hpb=b20ed0044cebfdd161511eae3dd31f3d0ccc8810;p=modules%2Fhydro.git diff --git a/src/HYDROData/HYDROData_Object.h b/src/HYDROData/HYDROData_Object.h index e8669db7..0c217f27 100644 --- a/src/HYDROData/HYDROData_Object.h +++ b/src/HYDROData/HYDROData_Object.h @@ -1,50 +1,38 @@ +// 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_Object_HeaderFile #define HYDROData_Object_HeaderFile -#include - -#include -#include -#include - -class QColor; -class QString; -class QVariant; -class QStringList; -class Handle(TDataStd_ReferenceList); -class Handle_HYDROData_Object; - -///! 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; -const ObjectKind KIND_CALCULATION = 5; -const ObjectKind KIND_PROFILE = 6; -const ObjectKind KIND_PROFILES_GROUP = 7; -const ObjectKind KIND_GUIDE_LINE = 8; -const ObjectKind KIND_ZONE = 9; -const ObjectKind KIND_REGION = 10; -const ObjectKind KIND_LAST = KIND_REGION; - -DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared) - -typedef QMap MapOfTreatedObjects; +#include -typedef NCollection_Sequence HYDROData_SequenceOfObjects; +DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity) +class TopoDS_Shape; +class Handle(HYDROData_IAltitudeObject); +class Handle(HYDROData_DummyObject3D); +class Handle(HYDROData_ShapesGroup); /**\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: /** @@ -52,210 +40,200 @@ 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_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 + DataTag_IsSubmersible, ///< the attribute "is submersible" }; public: DEFINE_STANDARD_RTTI(HYDROData_Object); /** - * Returns the kind of this object. Must be redefined in all objects of known type. + * Updates the name of this object. + * Reimplemented to update the names child groups. */ - HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_UNKNOWN;} + HYDRODATA_EXPORT virtual void SetName( const QString& theName ); /** - * Returns the name of this object. + * Update the geometry object. + * Call this method whenever you made changes for object data. */ - HYDRODATA_EXPORT QString GetName() const; + HYDRODATA_EXPORT virtual void Update(); /** - * Updates the name of this object. + * Returns the list of all reference objects of this object. */ - HYDRODATA_EXPORT void SetName(const QString& theName); + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const; /** - * 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. + * Sets the "MustBeUpdated" flag: if object is depended on updated features. + * Reimplemented to update the state of child 3D object. */ - HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const; + HYDRODATA_EXPORT virtual void Changed( Geometry ); + /** - * Updates object state. - * Base implementation dose nothing. - * \param theIsForce force reupdating of data object + * Sets the top(2d projection) shape of the object. */ - HYDRODATA_EXPORT virtual void Update( const bool theIsForce = true ); + HYDRODATA_EXPORT virtual void SetTopShape( const TopoDS_Shape& theShape ); /** - * Returns data of object wrapped to QVariant. - * Base implementation returns null value. + * Returns the top shape of the object. */ - HYDRODATA_EXPORT virtual QVariant GetDataVariant(); + HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const; /** - * Checks is object exists in the data structure. - * \returns true is object is not exists in the data model + * Sets the 3d shape of the object. */ - HYDRODATA_EXPORT bool IsRemoved() const; + HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape ); /** - * Removes object from the data structure. + * Returns the 3d shape of the object. */ - HYDRODATA_EXPORT void Remove(); + HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const; /** - * Returns unique integer identifier of the object (may be used for ordering of objects) + * Returns reference object which represent the 3D shape of object. */ - HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();} + HYDRODATA_EXPORT virtual Handle(HYDROData_DummyObject3D) GetObject3D() const; + /** - * 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 sequence of object groups. */ - HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Object theDestination) const; + HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGroups() const; /** - * Returns the label of this object. + * Returns group data model object by it id. */ - HYDRODATA_EXPORT TDF_Label& Label() {return myLab;} + HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) GetGroup( const int theGroupId ) const; -protected: + /** + * Returns group id by data model object. + */ + HYDRODATA_EXPORT virtual int GetGroupId( const Handle(HYDROData_ShapesGroup)& theGroup ) const; - friend class HYDROData_Iterator; /** - * Creates new object in the internal data structure. Use higher level objects - * to create objects with real content. + * Set reference altitude object for geometry object. */ - HYDRODATA_EXPORT HYDROData_Object(); + HYDRODATA_EXPORT virtual bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude ); /** - * Destructs properties of the object and object itself, removes it from the document. + * Returns reference altitude object of geometry object. */ - virtual HYDRODATA_EXPORT ~HYDROData_Object(); + HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetAltitudeObject() const; /** - * Put the object to the label of the document. - * \param theLabel new label of the object + * Clear the reference altitude object for geometry object. */ - HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel); + HYDRODATA_EXPORT virtual void RemoveAltitudeObject(); - /** - * 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 + + /** + * Sets filling color for object. */ - void SaveByteArray(const int theTag, const char* theData, const int theLen); + HYDRODATA_EXPORT virtual void SetFillingColor( const QColor& theColor ); /** - * 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 + * Returns filling color of object. */ - const char* ByteArray(const int theTag, int& theLen) const; + HYDRODATA_EXPORT virtual QColor GetFillingColor() const; - /** - * Internal method that used to store the reference object label attribute - * \param theObj pointer to reference object - * \param theTag tag of a label to store attribute (for 0 this is myLab) + /** + * Sets border color for object. */ - int NbReferenceObjects( const int theTag = 0 ) const; + HYDRODATA_EXPORT virtual void SetBorderColor( const QColor& theColor ); /** - * Internal method that used to store the reference object label attribute - * \param theObj pointer to reference object - * \param theTag tag of a label to store attribute (for 0 this is myLab) + * Returns border color of object. */ - void AddReferenceObject( const Handle_HYDROData_Object& theObj, - const int theTag = 0 ); + HYDRODATA_EXPORT virtual QColor GetBorderColor() const; + + HYDRODATA_EXPORT bool IsSubmersible() const; + HYDRODATA_EXPORT void SetIsSubmersible( bool ) const; + + HYDRODATA_EXPORT virtual void GetBoundaries( QList& theBoundShapes, + QStringList& theBoundNames ) const; + +protected: /** - * Internal method that used to store the reference object label attribute - * \param theObj pointer to reference object - * \param theTag tag of a label to store attribute (for 0 this is myLab) - * \param theIndex index in the list of references - - if more that len then just append it to the end of list - - if less than zero then prepend to the list - - indexing starts from 0 + * Creates new object in the internal data structure. Use higher level objects + * to create objects with real content. */ - void SetReferenceObject( const Handle_HYDROData_Object& theObj, - const int theTag = 0, - const int theIndex = 0 ); + HYDRODATA_EXPORT HYDROData_Object( Geometry ); /** - * Internal method that used to store the reference object label attribute - * \param theObjects sequence with pointers to reference objects - * \param theTag tag of a label to store attribute (for 0 this is myLab) + * Destructs properties of the object and object itself, removes it from the document. */ - void SetReferenceObjects( const HYDROData_SequenceOfObjects& theObjects, - const int theTag = 0 ); + virtual HYDRODATA_EXPORT ~HYDROData_Object(); + +protected: + HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const; + HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const; /** - * Internal method that used to retreive the reference object(s) attribute - * \param theTag tag of a label that keeps the attribute (for 0 this is myLab) - * \param theIndex index in the list of references - * - indexing starts from 0 - * \returns pointer to reference object or NULL if label is not set + * Dump the initial object creation to a Python script. + * Reimplemented to dump the object colors. */ - Handle_HYDROData_Object GetReferenceObject( const int theTag = 0, - const int theIndex = 0 ) const; + HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const; - HYDROData_SequenceOfObjects GetReferenceObjects( const int theTag = 0 ) const; /** - * Internal method that used to remove the reference object attribute - * \param theTag tag of a label that keeps the attribute (for 0 this is myLab) - * \param theIndex index in the list of references - * - indexing starts from 0 + * Checks and if necessary create child 3D object. + * Reimplement this function in your subclass if you + * do not want to create child 3D object. */ - void RemoveReferenceObject( const int theTag = 0, const int theIndex = 0 ); + HYDRODATA_EXPORT virtual void checkAndSetObject3D(); + /** - * Internal method that used to clear list of the reference objects attribute - * \param theTag tag of a label that keeps the attribute (for 0 this is myLab) + * 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. */ - void ClearReferenceObjects( const int theTag = 0 ); + HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const; /** - * Internal method that used to store the color attribute - * \param theTag tag of a label that keeps the attribute (for 0 this is myLab) - * \param theColor color to save + * Checks and if necessary create child altitude object. */ - void SetColor( const QColor& theColor, const int theTag = 0 ); + HYDRODATA_EXPORT virtual void checkAndSetAltitudeObject(); /** - * Internal method that used to retreive the color attribute - * \param theTag tag of a label that keeps the attribute (for 0 this is myLab) - * \param theDefColor default color to return if attribute has not been set before + * Return the child altitude object. */ - QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const; + HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) getChildAltitudeObject() const; - -protected: - void setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects, - QStringList& theScript, - const Handle(HYDROData_Object)& theRefObject, - const QString& theMethod ) const; -protected: + /** + * Create new one child group object. + */ + HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject(); - Handle(TDataStd_ReferenceList) getReferenceList( const int theTag, - const bool theIsCreate ) const; + /** + * Remove all child group objects. + */ + HYDRODATA_EXPORT virtual void RemoveGroupObjects(); + /** + * Removes the top shape from data label of the object. + */ + HYDRODATA_EXPORT void RemoveTopShape(); -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 + /** + * Removes the 3d shape from data label of the object. + */ + HYDRODATA_EXPORT void RemoveShape3D(); }; -///! Is Equal for HYDROData_Object mapping -HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Object& theObj1, const Handle_HYDROData_Object& theObj2); - #endif