+// 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_Entity_HeaderFile
#define HYDROData_Entity_HeaderFile
const ObjectKind KIND_VISUAL_STATE = 18;
const ObjectKind KIND_ARTIFICIAL_OBJECT = 19;
const ObjectKind KIND_NATURAL_OBJECT = 20;
-const ObjectKind KIND_LAST = KIND_NATURAL_OBJECT;
+const ObjectKind KIND_DUMMY_3D = 21;
+const ObjectKind KIND_SHAPES_GROUP = 22;
+const ObjectKind KIND_SPLITTED_GROUP = 23;
+const ObjectKind KIND_STREAM_ALTITUDE = 24;
+const ObjectKind KIND_OBSTACLE_ALTITUDE = 25;
+const ObjectKind KIND_STRICKLER_TABLE = 26;
+const ObjectKind KIND_LAST = KIND_OBSTACLE_ALTITUDE;
DEFINE_STANDARD_HANDLE(HYDROData_Entity, MMgt_TShared)
typedef NCollection_Sequence<Handle_HYDROData_Entity> HYDROData_SequenceOfObjects;
+///! Is Equal for HYDROData_Entity mapping
+HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2);
/**\class HYDROData_Entity
* \brief Generic class of any object in the data model.
*/
enum DataTag
{
- DataTag_First = 0 ///< first tag, to reserve
- // ...
+ DataTag_First = 0, ///< first tag, to reserve
+ DataTag_ZLevel, ///< z-level of object presentation
};
public:
*/
HYDRODATA_EXPORT virtual void SetName( const QString& theName );
+ /**
+ * Returns the name of this object valid for Python script.
+ */
+ HYDRODATA_EXPORT virtual QString GetObjPyName() const;
+
/**
* Dump object to Python script representation.
* Base implementation returns empty list,
*/
HYDRODATA_EXPORT virtual void Update();
+ HYDRODATA_EXPORT virtual void UpdateLocalCS( double theDx, double theDy );
+
+ /**
+ * Checks that object has 2D presentation. Base implementation returns false.
+ */
+ HYDRODATA_EXPORT virtual bool IsHas2dPrs() const;
+
+ /**
+ * Show object at the top of other model objects.
+ */
+ HYDRODATA_EXPORT virtual void Show();
+
+
/**
* Returns data of object wrapped to QVariant.
* Base implementation returns null value.
*/
HYDRODATA_EXPORT virtual bool CanRemove();
- /**
- * Returns unique integer identifier of the object (may be used for ordering of objects)
- */
- HYDRODATA_EXPORT inline int ID() const { return myLab.Tag(); }
-
/**
* 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
*/
- HYDRODATA_EXPORT void CopyTo( Handle_HYDROData_Entity theDestination ) const;
+ HYDRODATA_EXPORT virtual void CopyTo( const Handle(HYDROData_Entity)& theDestination ) const;
/**
* Returns the label of this object.
HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
+ /**
+ * Returns the z-level for object presentation, -1 if no z-level.
+ */
+ HYDRODATA_EXPORT virtual Standard_Boolean GetZLevel( Standard_Integer& theLevel ) const;
+
+ /**
+ * Set the z-level for object presentation.
+ */
+ HYDRODATA_EXPORT virtual void SetZLevel( const Standard_Integer& theLevel );
+
+ /**
+ * Remove the z-level of object presentation.
+ */
+ HYDRODATA_EXPORT virtual void RemoveZLevel();
+
+ /**
+ Find the Python object in the document by the object name.
+ @param theTreatedObjects the map of treated objects
+ @param theScript the script
+ */
+ void findPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
+ QStringList& theScript ) 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
+ */
+ HYDRODATA_EXPORT void SetColor( const QColor& theColor, const int theTag = 0 );
+
+ /**
+ * 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
+ */
+ HYDRODATA_EXPORT QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
+
protected:
friend class HYDROData_Iterator;
* Put the object to the label of the document.
* \param theLabel new label of the object
*/
- HYDRODATA_EXPORT virtual void SetLabel(TDF_Label theLabel);
+ HYDRODATA_EXPORT virtual void SetLabel( const TDF_Label& theLabel );
/**
* Internal method that used to store the byte array attribute
* \param theTag tag of a label that keeps the attribute (for 0 this is myLab)
*/
void ClearReferenceObjects( const int theTag = 0 );
+
+protected:
/**
- * 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
+ * Dump the initial object creation to a Python script.
+ * You should call it from DumpToPython implementation before
+ * dumping fields of the object.
*/
- void SetColor( const QColor& theColor, const int theTag = 0 );
+ HYDRODATA_EXPORT virtual QStringList dumpObjectCreation( MapOfTreatedObjects& theTreatedObjects ) const;
/**
- * 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
+ * Returns an object type name as a string for dumping to Python.
*/
- QColor GetColor( const QColor& theDefColor, const int theTag = 0 ) const;
-
-
-protected:
+ QString getPyTypeID() const;
void setPythonReferenceObject( MapOfTreatedObjects& theTreatedObjects,
QStringList& theScript,
const Handle(HYDROData_Entity)& theRefObject,
const QString& theMethod ) const;
+
+ bool checkObjectPythonDefinition( MapOfTreatedObjects& theTreatedObjects,
+ QStringList& theScript,
+ const Handle(HYDROData_Entity)& theRefObject ) const;
+
+ void setPythonObjectColor( QStringList& theScript,
+ const QColor& theColor,
+ const QColor& theDefaultColor,
+ const QString& theMethod ) const;
+
protected:
Handle(TDataStd_ReferenceList) getReferenceList( const int theTag,
TDF_Label myLab; ///< label of this object
};
-///! Is Equal for HYDROData_Entity mapping
-HYDRODATA_EXPORT bool IsEqual(const Handle_HYDROData_Entity& theObj1, const Handle_HYDROData_Entity& theObj2);
-
#endif
