src/ShapeUpgrade/ShapeUpgrade_Tool.hxx

   1 // Created on: 1999-08-31
   2 // Created by: Pavel DURANDIN
   3 // Copyright (c) 1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _ShapeUpgrade_Tool_HeaderFile
  18 #define _ShapeUpgrade_Tool_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <MMgt_TShared.hxx>
  25 class ShapeBuild_ReShape;
  26
  27
  28 class ShapeUpgrade_Tool;
  29 DEFINE_STANDARD_HANDLE(ShapeUpgrade_Tool, MMgt_TShared)
  30
  31 //! Tool is a root class for splitting classes
  32 //! Provides context for recording changes, basic
  33 //! precision value and limit (minimal and maximal)
  34 //! values for tolerances
  35 class ShapeUpgrade_Tool : public MMgt_TShared
  36 {
  37
  38 public:
  39
  40
  41   //! Empty constructor
  42   Standard_EXPORT ShapeUpgrade_Tool();
  43
  44   //! Copy all fields from another Root object
  45   Standard_EXPORT void Set (const Handle(ShapeUpgrade_Tool)& tool);
  46
  47   //! Sets context
  48     void SetContext (const Handle(ShapeBuild_ReShape)& context);
  49
  50   //! Returns context
  51     Handle(ShapeBuild_ReShape) Context() const;
  52
  53   //! Sets basic precision value
  54     void SetPrecision (const Standard_Real preci);
  55
  56   //! Returns basic precision value
  57     Standard_Real Precision() const;
  58
  59   //! Sets minimal allowed tolerance
  60     void SetMinTolerance (const Standard_Real mintol);
  61
  62   //! Returns minimal allowed tolerance
  63     Standard_Real MinTolerance() const;
  64
  65   //! Sets maximal allowed tolerance
  66     void SetMaxTolerance (const Standard_Real maxtol);
  67
  68   //! Returns maximal allowed tolerance
  69     Standard_Real MaxTolerance() const;
  70
  71   //! Returns tolerance limited by [myMinTol,myMaxTol]
  72     Standard_Real LimitTolerance (const Standard_Real toler) const;
  73
  74
  75
  76
  77   DEFINE_STANDARD_RTTI(ShapeUpgrade_Tool,MMgt_TShared)
  78
  79 protected:
  80
  81
  82
  83
  84 private:
  85
  86
  87   Handle(ShapeBuild_ReShape) myContext;
  88   Standard_Real myPrecision;
  89   Standard_Real myMinTol;
  90   Standard_Real myMaxTol;
  91
  92
  93 };
  94
  95
  96 #include <ShapeUpgrade_Tool.lxx>
  97
  98
  99
 100
 101
 102 #endif // _ShapeUpgrade_Tool_HeaderFile