include/opencascade/ShapeUpgrade_Tool.hxx

0001 // Created on: 1999-08-31
0002 // Created by: Pavel DURANDIN
0003 // Copyright (c) 1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _ShapeUpgrade_Tool_HeaderFile
0018 #define _ShapeUpgrade_Tool_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Transient.hxx>
0024 class ShapeBuild_ReShape;
0025
0026 //! Tool is a root class for splitting classes
0027 //! Provides context for recording changes, basic
0028 //! precision value and limit (minimal and maximal)
0029 //! values for tolerances
0030 class ShapeUpgrade_Tool : public Standard_Transient
0031 {
0032
0033 public:
0034   //! Empty constructor
0035   Standard_EXPORT ShapeUpgrade_Tool();
0036
0037   //! Copy all fields from another Root object
0038   Standard_EXPORT void Set(const occ::handle<ShapeUpgrade_Tool>& tool);
0039
0040   //! Sets context
0041   void SetContext(const occ::handle<ShapeBuild_ReShape>& context);
0042
0043   //! Returns context
0044   occ::handle<ShapeBuild_ReShape> Context() const;
0045
0046   //! Sets basic precision value
0047   void SetPrecision(const double preci);
0048
0049   //! Returns basic precision value
0050   double Precision() const;
0051
0052   //! Sets minimal allowed tolerance
0053   void SetMinTolerance(const double mintol);
0054
0055   //! Returns minimal allowed tolerance
0056   double MinTolerance() const;
0057
0058   //! Sets maximal allowed tolerance
0059   void SetMaxTolerance(const double maxtol);
0060
0061   //! Returns maximal allowed tolerance
0062   double MaxTolerance() const;
0063
0064   //! Returns tolerance limited by [myMinTol,myMaxTol]
0065   double LimitTolerance(const double toler) const;
0066
0067   DEFINE_STANDARD_RTTIEXT(ShapeUpgrade_Tool, Standard_Transient)
0068
0069 private:
0070   occ::handle<ShapeBuild_ReShape> myContext;
0071   double                          myPrecision;
0072   double                          myMinTol;
0073   double                          myMaxTol;
0074 };
0075
0076 #include <ShapeUpgrade_Tool.lxx>
0077
0078 #endif // _ShapeUpgrade_Tool_HeaderFile