refs #430: incorrect coordinates in dump polyline

[modules/hydro.git] / src / HYDROData / HYDROData_Tool.h

diff --git a/src/HYDROData/HYDROData_Tool.h b/src/HYDROData/HYDROData_Tool.h
index 04835c87ea0f3fba014aec73f3e32adae583f5bb..bb71d8c466912899e249743731237046487b1dc0 100644 (file)
--- a/src/HYDROData/HYDROData_Tool.h
+++ b/src/HYDROData/HYDROData_Tool.h
@@ -7,10 +7,16 @@
 
 #include <Precision.hxx>
 
+#include <TopAbs_ShapeEnum.hxx>
+
 #include <QString>
 #include <QStringList>
+#include <gp_XY.hxx>
+#include <TopoDS_Face.hxx>
 
 class QFile;
+class TopoDS_Shape;
+class TopTools_SequenceOfShape;
 class Handle(HYDROData_Document);
 
 class HYDRODATA_EXPORT HYDROData_Tool {
@@ -22,43 +28,56 @@ public:
                                                             const QString&     theSep = "\n" );
 
   /**
-   * Enables "MustBeUpdated" flag for Images that are depended on "MustBeUpdated" images.
+   * Enables "MustBeUpdated" flag for objects that are depended on "MustBeUpdated" objects.
    * \param theDoc document where this operation is performed
    */
-  static void                           SetMustBeUpdatedImages( const Handle(HYDROData_Document)& theDoc );
+  static void                           SetMustBeUpdatedObjects( const Handle(HYDROData_Document)& theDoc );
 
   /**
    * \brief Generate name for new object.
-   * \param theModule module
+   * \param theDoc document
    * \param thePrefix name prefix
    * \param theUsedNames list of already used names
+   * \param theIsTryToUsePurePrefix if true - the prefix will be returned if the name equal to the prefix is not busy
    * \return generated name
    */
   static QString                        GenerateObjectName( const Handle(HYDROData_Document)& theDoc,
                                                             const QString&                    thePrefix,
-                                                            const QStringList&                theUsedNames = QStringList() );
+                                                            const QStringList&                theUsedNames = QStringList(),
+                                                            const bool                        theIsTryToUsePurePrefix = false );
 
   /**
-   * \brief Find the data object with the specified name.
-   * \param theModule module
-   * \param theName name
-   * \param theObjectKind kind of object
-   * \return data object
+   * \brief Checks the type of object.
+   * \param theObject object to check
+   * \return true if object is geometry object
    */
-  static Handle(HYDROData_Entity)       FindObjectByName( const Handle(HYDROData_Document)& theDoc,
-                                                          const QString&                    theName,
-                                                          const ObjectKind                  theObjectKind = KIND_UNKNOWN );
+  static bool                           IsGeometryObject( const Handle(HYDROData_Entity)& theObject );
 
   /**
-   * \brief Find the data objects with the specified names.
-   * \param theModule module
-   * \param theNames list of names
-   * \param theObjectKind kind of object
-   * \return list of data objects
+   * \brief Updates the child object name.
+   * \param theOldStr old father object name
+   * \param theNewStr new father object name
+   * \param theObject object to update
+   */
+  static void                           UpdateChildObjectName( const QString&                  theOldStr,
+                                                               const QString&                  theNewStr,
+                                                               const Handle(HYDROData_Entity)& theObject );
+
+
+  /**
+   * \brief Generate name for new object in python environment.
+   * \param theTreatedObjects objects which was alredy created by dump operation
+   * \param thePrefix name prefix
+   * \return generated name
    */
-  static HYDROData_SequenceOfObjects    FindObjectsByNames( const Handle(HYDROData_Document)& theDoc,
-                                                            const QStringList&                theNames,
-                                                            const ObjectKind                  theObjectKind = KIND_UNKNOWN );
+  static QString                        GenerateNameForPython( const MapOfTreatedObjects& theTreatedObjects,
+                                                               const QString&             thePrefix );
+ /**
+  * Computes Point State from TopAbs (simplified & limited method).
+  */
+
+ static TopAbs_State                    ComputePointState( const gp_XY& thePnt2d, 
+                                                              const TopoDS_Face& theFace );
 };
 
 inline bool ValuesEquals( const double& theFirst, const double& theSecond )