+// 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 <HYDROData.h>
-
-#include <TDF_Label.hxx>
-#include <QString>
-
-///! Kind of an object in a document
-typedef int ObjectKind;
-///! Unrecognized object
-const ObjectKind KIND_UNKNOWN = 0;
-const ObjectKind KIND_IMAGE = 1;
+#include <HYDROData_Entity.h>
-DEFINE_STANDARD_HANDLE(HYDROData_Object, MMgt_TShared)
+class TopoDS_Shape;
+class HYDROData_IAltitudeObject;
+class HYDROData_DummyObject3D;
+class 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:
+ /**
+ * Enumeration of tags corresponding to the persistent object parameters.
+ */
+ enum DataTag
+ {
+ 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);
+ DEFINE_STANDARD_RTTIEXT(HYDROData_Object, HYDROData_Entity);
/**
- * 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, bool isDefault = false );
/**
- * 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;
/**
- * Checks is object exists in the data structure.
- * \returns true is object is not exists in the data model
+ * Sets the "MustBeUpdated" flag: if object is depended on updated features.
+ * Reimplemented to update the state of child 3D object.
*/
- HYDRODATA_EXPORT bool IsRemoved() const;
+ HYDRODATA_EXPORT virtual void Changed( Geometry );
+
/**
- * Removes object from the data structure.
+ * Sets the top(2d projection) shape of the object.
*/
- HYDRODATA_EXPORT void Remove();
+ HYDRODATA_EXPORT virtual void SetTopShape( const TopoDS_Shape& theShape );
/**
- * Returns unique integer identifier of the object (may be used for ordering of objects)
+ * Returns the top shape of the object.
*/
- HYDRODATA_EXPORT inline int ID() const {return myLab.Tag();}
+ HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() 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
+ * Sets the 3d shape of the object.
*/
- HYDRODATA_EXPORT void CopyTo(Handle_HYDROData_Object theDestination) const;
+ HYDRODATA_EXPORT virtual void SetShape3D( const TopoDS_Shape& theShape );
-protected:
+ /**
+ * Returns the 3d shape of the object.
+ */
+ HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
+
+ /**
+ * 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 bool SetAltitudeObject( const Handle(HYDROData_IAltitudeObject)& theAltitude );
+
+ /**
+ * Returns reference altitude object of geometry object.
+ */
+ HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) GetAltitudeObject() const;
+
+ /**
+ * Clear the reference altitude object for geometry object.
+ */
+ HYDRODATA_EXPORT virtual void RemoveAltitudeObject();
- friend class HYDROData_Iterator;
+
+ /**
+ * Sets filling color for object.
+ */
+ HYDRODATA_EXPORT virtual void SetFillingColor( const QColor& theColor );
+
+ /**
+ * Returns filling color of object.
+ */
+ HYDRODATA_EXPORT virtual QColor GetFillingColor() const;
+
+ /**
+ * Sets border color for object.
+ */
+ HYDRODATA_EXPORT virtual void SetBorderColor( const QColor& theColor );
+
+ /**
+ * Returns border color of object.
+ */
+ HYDRODATA_EXPORT virtual QColor GetBorderColor() const;
+
+ HYDRODATA_EXPORT bool IsSubmersible() const;
+ HYDRODATA_EXPORT void SetIsSubmersible( bool ) const;
+
+ HYDRODATA_EXPORT virtual void GetBoundaries( QList<TopoDS_Shape>& theBoundShapes,
+ QStringList& theBoundNames ) const;
+
+protected:
/**
- * Creates new object in the internal data structure. Use higher level objects
+ * Creates new object in the internal data structure. Use higher level objects
* to create objects with real content.
*/
- HYDRODATA_EXPORT HYDROData_Object();
+ HYDRODATA_EXPORT HYDROData_Object( Geometry );
/**
* Destructs properties of the object and object itself, removes it from the document.
*/
virtual HYDRODATA_EXPORT ~HYDROData_Object();
+protected:
+ HYDRODATA_EXPORT virtual QColor DefaultFillingColor() const;
+ HYDRODATA_EXPORT virtual QColor DefaultBorderColor() const;
+
+ /**
+ * Dump the initial object creation to a Python script.
+ * Reimplemented to dump the object colors.
+ */
+ HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
+
+
/**
- * 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();
+
/**
- * Returns the label of this object.
+ * 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.
*/
- TDF_Label& Label() {return myLab;}
-
+ HYDRODATA_EXPORT virtual ObjectKind getAltitudeObjectType() const;
+
/**
- * 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
+ * Checks and if necessary create child altitude object.
*/
- void SaveByteArray(const int theTag, const char* theData, const int theLen);
+ HYDRODATA_EXPORT virtual void checkAndSetAltitudeObject();
/**
- * 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
+ * Return the child altitude object.
*/
- const char* ByteArray(const int theTag, int& theLen);
+ HYDRODATA_EXPORT virtual Handle(HYDROData_IAltitudeObject) getChildAltitudeObject() 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
-};
-///! Is Equal for HYDROData_Object mapping
-HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Object& theObj1, const Handle_HYDROData_Object& theObj2);
+ /**
+ * Create new one child group object.
+ */
+ HYDRODATA_EXPORT virtual Handle(HYDROData_ShapesGroup) createGroupObject();
+
+ /**
+ * Remove all child group objects.
+ */
+ HYDRODATA_EXPORT virtual void RemoveGroupObjects();
+
+ /**
+ * Removes the top shape from data label of the object.
+ */
+ HYDRODATA_EXPORT void RemoveTopShape();
+
+ /**
+ * Removes the 3d shape from data label of the object.
+ */
+ HYDRODATA_EXPORT void RemoveShape3D();
+};
#endif
