+
#ifndef HYDROData_Object_HeaderFile
#define HYDROData_Object_HeaderFile
-#include <HYDROData.h>
-
-#include <NCollection_Sequence.hxx>
-#include <TDF_Label.hxx>
-#include <QMap>
+#include <HYDROData_Entity.h>
-class QString;
-class QVariant;
-class QStringList;
-///! 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;
+DEFINE_STANDARD_HANDLE(HYDROData_Object, HYDROData_Entity)
-DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared)
-
-typedef QMap<QString,Handle(Standard_Transient)> MapOfTreatedObjects;
+class TopoDS_Shape;
+class Handle(HYDROData_Bathymetry);
+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:
/**
*/
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
+ DataTag_Object3D, ///< child 3D object
+ DataTag_EdgesGroup, ///< child group objects
};
public:
DEFINE_STANDARD_RTTI(HYDROData_Object);
/**
- * Returns the kind of this object. Must be redefined in all objects of known type.
+ * 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.
*/
- 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( MapOfTreatedObjects& theTreatedObjects ) const;
+ HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const = 0;
+
/**
- * Updates object state.
- * Base implementation dose nothing.
- * \param theIsForce force reupdating of data object
+ * Returns reference object which represent the 3D shape of object.
*/
- HYDRODATA_EXPORT virtual void Update( const bool theIsForce = true );
+ HYDRODATA_EXPORT virtual Handle(HYDROData_DummyObject3D) GetObject3D() const;
/**
- * Returns data of object wrapped to QVariant.
- * Base implementation returns null value.
+ * Returns sequence of object groups.
*/
- HYDRODATA_EXPORT virtual QVariant GetDataVariant();
+ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGroups() const;
+
/**
- * 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 bool 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 virtual void RemoveBathymetry();
+
+ /**
+ * Sets filling color for object.
*/
- HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();}
+ 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 void CopyTo(Handle_HYDROData_Object theDestination) const;
+ HYDRODATA_EXPORT virtual QColor GetFillingColor() const;
+
+ /**
+ * Sets border color for object.
+ */
+ 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;
+
+ /**
+ * Returns default filling color for new object.
+ */
+ HYDRODATA_EXPORT static QColor DefaultFillingColor();
+
+ /**
+ * Returns default border color for new object.
+ */
+ HYDRODATA_EXPORT static QColor DefaultBorderColor();
protected:
- friend class HYDROData_Iterator;
+ /**
+ * Returns default filling color for new object.
+ */
+ HYDRODATA_EXPORT virtual QColor getDefaultFillingColor() const;
+
+ /**
+ * Returns default border color for new object.
+ */
+ HYDRODATA_EXPORT virtual QColor getDefaultBorderColor() const;
+
+protected:
/**
* Creates new object in the internal data structure. Use higher level objects
*/
virtual HYDRODATA_EXPORT ~HYDROData_Object();
+protected:
+
/**
- * Put the object to the label of the document.
- * \param theLabel new label of the object
+ * 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 SetLabel(TDF_Label theLabel);
+ HYDRODATA_EXPORT virtual void checkAndSetObject3D();
+
/**
- * 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
+ * Create new one child group object.
*/
- void SaveByteArray(const int theTag, const char* theData, const int theLen);
+ HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
/**
- * 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
+ * Create all necessary child group objects.
+ * Base implementation does nothing.
*/
- const char* ByteArray(const int theTag, int& theLen) const;
+ HYDRODATA_EXPORT virtual void createGroupObjects();
-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
-};
+ /**
+ * Remove all child group objects.
+ */
+ HYDRODATA_EXPORT virtual void removeGroupObjects();
-typedef NCollection_Sequence<Handle_HYDROData_Object> HYDROData_SequenceOfObjects;
-///! Is Equal for HYDROData_Object mapping
-HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Object& theObj1, const Handle_HYDROData_Object& theObj2);
+ /**
+ * 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
