include/opencascade/IntSurf_QuadricTool.hxx

0001 // Created on: 1992-09-30
0002 // Created by: Jacques GOUSSARD
0003 // Copyright (c) 1992-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 _IntSurf_QuadricTool_HeaderFile
0018 #define _IntSurf_QuadricTool_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Real.hxx>
0025 class IntSurf_Quadric;
0026 class gp_Vec;
0027
0028
0029 //! This class provides a tool on a quadric that can be
0030 //! used to instantiates the Walking algorithms (see
0031 //! package IntWalk) with a Quadric from IntSurf
0032 //! as implicit surface.
0033 class IntSurf_QuadricTool
0034 {
0035 public:
0036
0037   DEFINE_STANDARD_ALLOC
0038
0039
0040   //! Returns the value of the function.
0041     static Standard_Real Value (const IntSurf_Quadric& Quad, const Standard_Real X, const Standard_Real Y, const Standard_Real Z);
0042
0043   //! Returns the gradient of the function.
0044     static void Gradient (const IntSurf_Quadric& Quad, const Standard_Real X, const Standard_Real Y, const Standard_Real Z, gp_Vec& V);
0045
0046   //! Returns the value and the gradient.
0047     static void ValueAndGradient (const IntSurf_Quadric& Quad, const Standard_Real X, const Standard_Real Y, const Standard_Real Z, Standard_Real& Val, gp_Vec& Grad);
0048
0049   //! returns the tolerance of the zero of the implicit function
0050   Standard_EXPORT static Standard_Real Tolerance (const IntSurf_Quadric& Quad);
0051
0052
0053
0054
0055 protected:
0056
0057
0058
0059
0060
0061 private:
0062
0063
0064
0065
0066
0067 };
0068
0069
0070 #include <IntSurf_QuadricTool.lxx>
0071
0072
0073
0074
0075
0076 #endif // _IntSurf_QuadricTool_HeaderFile