0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepBuilderAPI / BRepBuilderAPI_MakeVertex.cdl
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 class MakeVertex from BRepBuilderAPI inherits MakeShape from BRepBuilderAPI
18
19         ---Purpose: Describes functions to build BRepBuilder vertices directly
20         -- from 3D geometric points. A vertex built using a
21         -- MakeVertex object is only composed of a 3D point and
22         -- a default precision value (Precision::Confusion()).
23         -- Later on, 2D representations can be added, for example,
24         -- when inserting a vertex in an edge.
25         -- A MakeVertex object provides a framework for:
26         -- -   defining and implementing the construction of a vertex, and
27         -- -   consulting the result.
28
29 uses
30     Pnt        from gp,
31     Vertex     from TopoDS,
32     MakeVertex from BRepLib
33
34 is
35     Create (P : Pnt from gp) 
36         ---Purpose: Constructs a vertex from point P.
37         -- Example create a vertex from a 3D point.
38         -- gp_Pnt P(0,0,10);
39         -- TopoDS_Vertex V = BRepBuilderAPI_MakeVertex(P);
40     returns MakeVertex from BRepBuilderAPI;
41     
42     Vertex(me) returns Vertex from TopoDS
43         ---C++: return const &
44         ---C++: alias "Standard_EXPORT operator TopoDS_Vertex() const;"
45         ---Purpose: Returns the constructed vertex.
46     is static;
47     
48 fields
49
50     myMakeVertex : MakeVertex from BRepLib;        
51                
52
53 end MakeVertex;