src/HYDROData/HYDROData_Tool.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #ifndef HYDROData_Tool_HeaderFile
  20 #define HYDROData_Tool_HeaderFile
  21
  22 #include "HYDROData.h"
  23 #include <QStringList>
  24 #include <Precision.hxx>
  25
  26 class Handle_HYDROData_Document;
  27 class Handle_HYDROData_Entity;
  28 class HYDROData_SequenceOfObjects;
  29 class MapOfTreatedObjects;
  30 class gp_XY;
  31 class QColor;
  32 class QFile;
  33 class TCollection_ExtendedString;
  34 #ifdef WIN32
  35   enum TopAbs_State;
  36 #else
  37   #include <TopAbs_State.hxx>
  38 #endif
  39 class TopoDS_Edge;
  40 class TopoDS_Face;
  41 class TopoDS_Shape;
  42 class TopoDS_Wire;
  43 class TopTools_SequenceOfShape;
  44
  45 class HYDRODATA_EXPORT HYDROData_Tool {
  46
  47 public:
  48
  49   static void                           WriteStringsToFile( QFile&             theFile,
  50                                                             const QStringList& theStrings,
  51                                                             const QString&     theSep = "\n" );
  52
  53   /**
  54    * \brief Generate name for new object.
  55    * \param theDoc document
  56    * \param thePrefix name prefix
  57    * \param theUsedNames list of already used names
  58    * \param theIsTryToUsePurePrefix if true - the prefix will be returned if the name equal to the prefix is not busy
  59    * \return generated name
  60    */
  61   static QString                        GenerateObjectName( const Handle_HYDROData_Document& theDoc,
  62                                                             const QString&                   thePrefix,
  63                                                             const QStringList&               theUsedNames = QStringList(),
  64                                                             const bool                       theIsTryToUsePurePrefix = false );
  65
  66   /**
  67    * \brief Checks the type of object.
  68    * \param theObject object to check
  69    * \return true if object is geometry object
  70    */
  71   static bool                           IsGeometryObject( const Handle_HYDROData_Entity& theObject );
  72
  73   /**
  74    * \brief Updates the child object name.
  75    * \param theOldStr old father object name
  76    * \param theNewStr new father object name
  77    * \param theObject object to update
  78    */
  79   static void                           UpdateChildObjectName( const QString&                  theOldStr,
  80                                                                const QString&                  theNewStr,
  81                                                                const Handle_HYDROData_Entity& theObject );
  82
  83
  84   /**
  85    * \brief Generate name for new object in python environment.
  86    * \param theTreatedObjects objects which was alredy created by dump operation
  87    * \param thePrefix name prefix
  88    * \return generated name
  89    */
  90   static QString                        GenerateNameForPython( const MapOfTreatedObjects& theTreatedObjects,
  91                                                                const QString&             thePrefix );
  92  /**
  93   * Computes Point State from TopAbs (simplified & limited method).
  94   */
  95
  96  static TopAbs_State                    ComputePointState( const gp_XY& thePnt2d,
  97                                                                const TopoDS_Face& theFace );
  98
  99   static double GetAltitudeForEdge( const TopoDS_Edge& theEdge,
 100                                     const gp_XY& thePoint,
 101                                     double theParameterTolerance,
 102                                     double theSquareDistanceTolerance,
 103                                     double theInvalidAltitude );
 104   static double GetAltitudeForWire( const TopoDS_Wire& theWire,
 105                                     const gp_XY& thePoint,
 106                                     double theParameterTolerance,
 107                                     double theSquareDistanceTolerance,
 108                                     double theInvalidAltitude );
 109
 110   /**
 111    * \brief Returns the first shape from the group.
 112    * \param theGroups the list of groups
 113    * \param theGroupId the group id
 114    */
 115   static TopoDS_Shape getFirstShapeFromGroup( const HYDROData_SequenceOfObjects& theGroups,
 116                                               const int                          theGroupId );
 117
 118   static TCollection_ExtendedString toExtString( const QString& );
 119   static QString                    toQString( const TCollection_ExtendedString& );
 120 };
 121
 122 inline bool ValuesEquals( const double& theFirst, const double& theSecond )
 123 {
 124   return theFirst > ( theSecond - Precision::Confusion() ) &&
 125          theFirst < ( theSecond + Precision::Confusion() );
 126 }
 127
 128 inline bool ValuesMoreEquals( const double& theFirst, const double& theSecond )
 129 {
 130   return theFirst >= theSecond || ValuesEquals( theFirst, theSecond );
 131 }
 132
 133 inline  bool ValuesLessEquals( const double& theFirst, const double& theSecond )
 134 {
 135   return theFirst <= theSecond || ValuesEquals( theFirst, theSecond );
 136 }
 137
 138 HYDRODATA_EXPORT std::ostream& operator<<( std::ostream& theStream, const QString& theText );
 139 HYDRODATA_EXPORT std::ostream& operator<<( std::ostream& theStream, const QColor& theText );
 140 HYDRODATA_EXPORT std::ostream& operator<<( std::ostream& theStream, const TopoDS_Shape& theShape );
 141 HYDRODATA_EXPORT std::ostream& operator<<( std::ostream& theStream, const TopoDS_Face& theFace );
 142
 143 #endif
 144
 145