include/opencascade/ShapeBuild_Vertex.hxx

0001 // Created on: 1998-06-11
0002 // Created by: data exchange team
0003 // Copyright (c) 1998-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 _ShapeBuild_Vertex_HeaderFile
0018 #define _ShapeBuild_Vertex_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 class TopoDS_Vertex;
0024 class gp_Pnt;
0025
0026 //! Provides low-level functions used for constructing vertices
0027 class ShapeBuild_Vertex
0028 {
0029 public:
0030   DEFINE_STANDARD_ALLOC
0031
0032   //! Combines new vertex from two others. This new one is the
0033   //! smallest vertex which comprises both of the source vertices.
0034   //! The function takes into account the positions and tolerances
0035   //! of the source vertices.
0036   //! The tolerance of the new vertex will be equal to the minimal
0037   //! tolerance that is required to comprise source vertices
0038   //! multiplied by tolFactor (in order to avoid errors because
0039   //! of discreteness of calculations).
0040   Standard_EXPORT TopoDS_Vertex CombineVertex(const TopoDS_Vertex& V1,
0041                                               const TopoDS_Vertex& V2,
0042                                               const Standard_Real  tolFactor = 1.0001) const;
0043
0044   //! The same function as above, except that it accepts two points
0045   //! and two tolerances instead of vertices
0046   Standard_EXPORT TopoDS_Vertex CombineVertex(const gp_Pnt&       pnt1,
0047                                               const gp_Pnt&       pnt2,
0048                                               const Standard_Real tol1,
0049                                               const Standard_Real tol2,
0050                                               const Standard_Real tolFactor = 1.0001) const;
0051
0052 protected:
0053 private:
0054 };
0055
0056 #endif // _ShapeBuild_Vertex_HeaderFile