src/BRepBuilderAPI/BRepBuilderAPI_MakeVertex.hxx

   1 // Created on: 1993-07-06
   2 // Created by: Remi LEQUETTE
   3 // Copyright (c) 1993-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 _BRepBuilderAPI_MakeVertex_HeaderFile
  18 #define _BRepBuilderAPI_MakeVertex_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <BRepLib_MakeVertex.hxx>
  25 #include <BRepBuilderAPI_MakeShape.hxx>
  26 class gp_Pnt;
  27 class TopoDS_Vertex;
  28
  29
  30 //! Describes functions to build BRepBuilder vertices directly
  31 //! from 3D geometric points. A vertex built using a
  32 //! MakeVertex object is only composed of a 3D point and
  33 //! a default precision value (Precision::Confusion()).
  34 //! Later on, 2D representations can be added, for example,
  35 //! when inserting a vertex in an edge.
  36 //! A MakeVertex object provides a framework for:
  37 //! -   defining and implementing the construction of a vertex, and
  38 //! -   consulting the result.
  39 class BRepBuilderAPI_MakeVertex  : public BRepBuilderAPI_MakeShape
  40 {
  41 public:
  42
  43   DEFINE_STANDARD_ALLOC
  44
  45
  46   //! Constructs a vertex from point P.
  47   //! Example create a vertex from a 3D point.
  48   //! gp_Pnt P(0,0,10);
  49   //! TopoDS_Vertex V = BRepBuilderAPI_MakeVertex(P);
  50   Standard_EXPORT BRepBuilderAPI_MakeVertex(const gp_Pnt& P);
  51
  52   //! Returns the constructed vertex.
  53   Standard_EXPORT const TopoDS_Vertex& Vertex();
  54   Standard_EXPORT operator TopoDS_Vertex();
  55
  56
  57
  58
  59 protected:
  60
  61
  62
  63
  64
  65 private:
  66
  67
  68
  69   BRepLib_MakeVertex myMakeVertex;
  70
  71
  72 };
  73
  74
  75
  76
  77
  78
  79
  80 #endif // _BRepBuilderAPI_MakeVertex_HeaderFile