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 //! This class provides a tool on a quadric that can be
0029 //! used to instantiates the Walking algorithms (see
0030 //! package IntWalk) with a Quadric from IntSurf
0031 //! as implicit surface.
0032 class IntSurf_QuadricTool
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! Returns the value of the function.
0038   static Standard_Real Value(const IntSurf_Quadric& Quad,
0039                              const Standard_Real    X,
0040                              const Standard_Real    Y,
0041                              const Standard_Real    Z);
0042
0043   //! Returns the gradient of the function.
0044   static void Gradient(const IntSurf_Quadric& Quad,
0045                        const Standard_Real    X,
0046                        const Standard_Real    Y,
0047                        const Standard_Real    Z,
0048                        gp_Vec&                V);
0049
0050   //! Returns the value and the gradient.
0051   static void ValueAndGradient(const IntSurf_Quadric& Quad,
0052                                const Standard_Real    X,
0053                                const Standard_Real    Y,
0054                                const Standard_Real    Z,
0055                                Standard_Real&         Val,
0056                                gp_Vec&                Grad);
0057
0058   //! returns the tolerance of the zero of the implicit function
0059   Standard_EXPORT static Standard_Real Tolerance(const IntSurf_Quadric& Quad);
0060
0061 protected:
0062 private:
0063 };
0064
0065 #include <IntSurf_QuadricTool.lxx>
0066
0067 #endif // _IntSurf_QuadricTool_HeaderFile