Salome HOME
another z layer for hilight presentation
[modules/hydro.git] / src / HYDROData / HYDROData_Document.h
index b583787ddd8345584f8b24b339212bcc4ee3e663..ffdaf981451ad7b33a5fd50d030a3f3c1a8e2346 100644 (file)
@@ -85,6 +85,45 @@ public:
   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects,
                                                      const bool           theIsMultiFile ) const;
 
+public:
+
+  // Methods to work with objects presentation.
+
+  //! Returns the order of objects presentation. Objects in returned sequence
+  //! are order from top to low depending on z-level parameter. Objects that
+  //! have no z-level parameter are located at the end of sequence and
+  //! sorted alphabetically.
+  //! Only the following types of objects considered:
+  //!   1. KIND_IMAGE
+  //!   2. KIND_IMMERSIBLE_ZONE
+  //!   3. KIND_CHANNEL
+  //!   4. KIND_RIVER
+  //!   5. KIND_STREAM
+  //!   6. KIND_OBSTACLE
+  //!   7. KIND_DIGUE
+  //!   8. KIND_POLYLINEXY
+  //!   9. KIND_ZONE
+  //! \param theIsAll if flag is true then all objects will be included,
+  //!                 otherwise only objects which have the z-level parameter
+  //! \returns ordered sequence of objects
+  HYDRODATA_EXPORT HYDROData_SequenceOfObjects GetObjectsLayerOrder( 
+    const Standard_Boolean theIsAll = Standard_True ) const;
+
+  //! Sets the order of objects presentation.
+  HYDRODATA_EXPORT void SetObjectsLayerOrder( const HYDROData_SequenceOfObjects& theOrder );
+
+  //! Show object at the top of other model objects. If the object
+  //! already has the z-level parameter then nothing will be done.
+  HYDRODATA_EXPORT void Show( const Handle_HYDROData_Entity& theObject );
+
+  //! Show sequence of objects at the top of other model objects.
+  //! The objects from the sequence will be sorted alphabetically at first.
+  HYDRODATA_EXPORT void Show( const HYDROData_SequenceOfObjects& theObjects );
+
+  //! Removes the order of objects presentation.
+  HYDRODATA_EXPORT void RemoveObjectsLayerOrder();
+
+
 public:
 
   //! Starts a new operation (opens a tansaction)