include/opencascade/GeomAPI.hxx

0001 // Created on: 1994-03-17
0002 // Created by: Bruno DUMORTIER
0003 // Copyright (c) 1994-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 _GeomAPI_HeaderFile
0018 #define _GeomAPI_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Geom2d_Curve.hxx>
0025 #include <Geom_Curve.hxx>
0026
0027 class gp_Pln;
0028
0029
0030 //! The   GeomAPI   package  provides  an  Application
0031 //! Programming Interface for the Geometry.
0032 //!
0033 //! The API is a set of  classes and methods aiming to
0034 //! provide :
0035 //!
0036 //! * High level and simple calls  for the most common
0037 //! operations.
0038 //!
0039 //! *    Keeping   an   access  on    the    low-level
0040 //! implementation of high-level calls.
0041 //!
0042 //! The API  provides classes to  call the algorithms
0043 //! of the Geometry
0044 //!
0045 //! * The  constructors  of the classes  provides  the
0046 //! different constructions methods.
0047 //!
0048 //! * The  class keeps as fields the   different tools
0049 //! used by the algorithms
0050 //!
0051 //! *   The class  provides  a  casting  method to get
0052 //! automatically the  result  with  a   function-like
0053 //! call.
0054 //!
0055 //! For example to evaluate the distance <D> between a
0056 //! point <P> and a curve <C>, one can writes :
0057 //!
0058 //! D = GeomAPI_ProjectPointOnCurve(P,C);
0059 //!
0060 //! or
0061 //!
0062 //! GeomAPI_ProjectPointOnCurve PonC(P,C);
0063 //! D = PonC.LowerDistance();
0064 class GeomAPI
0065 {
0066 public:
0067
0068   DEFINE_STANDARD_ALLOC
0069
0070
0071   //! This function builds (in the
0072   //! parametric space of the plane P) a 2D curve equivalent to the 3D curve
0073   //! C. The 3D curve C is considered to be located in the plane P.
0074   //! Warning
0075   //! The 3D curve C must be of one of the following types:
0076   //! -      a line
0077   //! -      a circle
0078   //! -      an ellipse
0079   //! -      a hyperbola
0080   //! -      a parabola
0081   //! -      a Bezier curve
0082   //! -      a BSpline curve
0083   //! Exceptions Standard_NoSuchObject if C is not a defined type curve.
0084   Standard_EXPORT static Handle(Geom2d_Curve) To2d (const Handle(Geom_Curve)& C, const gp_Pln& P);
0085
0086   //! Builds a 3D curve equivalent to the 2D curve C
0087   //! described in the parametric space defined by the local
0088   //! coordinate system of plane P.
0089   //! The resulting 3D curve is of the same nature as that of the curve C.
0090   Standard_EXPORT static Handle(Geom_Curve) To3d (const Handle(Geom2d_Curve)& C, const gp_Pln& P);
0091
0092 };
0093
0094 #endif // _GeomAPI_HeaderFile