0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / Geom2dGcc / Geom2dGcc.hxx
diff --git a/src/Geom2dGcc/Geom2dGcc.hxx b/src/Geom2dGcc/Geom2dGcc.hxx
new file mode 100644 (file)
index 0000000..4b4b129
--- /dev/null
@@ -0,0 +1,190 @@
+// Created on: 1992-06-29
+// Created by: Remi GILET
+// Copyright (c) 1992-1999 Matra Datavision
+// Copyright (c) 1999-2014 OPEN CASCADE SAS
+//
+// This file is part of Open CASCADE Technology software library.
+//
+// This library is free software; you can redistribute it and/or modify it under
+// the terms of the GNU Lesser General Public License version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
+//
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
+
+#ifndef _Geom2dGcc_HeaderFile
+#define _Geom2dGcc_HeaderFile
+
+#include <Standard.hxx>
+#include <Standard_DefineAlloc.hxx>
+#include <Standard_Handle.hxx>
+
+class Geom2dGcc_QualifiedCurve;
+class Geom2dAdaptor_Curve;
+class Geom2dGcc_CurveTool;
+class Geom2dGcc_QualifiedCurve;
+class Geom2dGcc_Circ2d3Tan;
+class Geom2dGcc_Circ2d2TanRad;
+class Geom2dGcc_Circ2d2TanOn;
+class Geom2dGcc_Circ2dTanOnRad;
+class Geom2dGcc_Circ2dTanCen;
+class Geom2dGcc_Lin2d2Tan;
+class Geom2dGcc_Lin2dTanObl;
+class Geom2dGcc_QCurve;
+class Geom2dGcc_CurveToolGeo;
+class Geom2dGcc_Circ2d2TanOnGeo;
+class Geom2dGcc_Circ2d2TanRadGeo;
+class Geom2dGcc_Circ2dTanCenGeo;
+class Geom2dGcc_Circ2dTanOnRadGeo;
+class Geom2dGcc_Circ2d3TanIter;
+class Geom2dGcc_FunctionTanCuCuCu;
+class Geom2dGcc_Circ2d2TanOnIter;
+class Geom2dGcc_FunctionTanCuCuOnCu;
+class Geom2dGcc_Lin2dTanOblIter;
+class Geom2dGcc_FunctionTanObl;
+class Geom2dGcc_Lin2d2TanIter;
+class Geom2dGcc_FunctionTanCuCu;
+class Geom2dGcc_FunctionTanCuPnt;
+class Geom2dGcc_FunctionTanCirCu;
+
+
+//! The Geom2dGcc package describes qualified 2D
+//! curves used in the construction of constrained geometric
+//! objects by an algorithm provided by the Geom2dGcc package.
+//! A qualified 2D curve is a curve with a qualifier which
+//! specifies whether the solution of a construction
+//! algorithm using the qualified curve (as an argument):
+//! -   encloses the curve, or
+//! -   is enclosed by the curve, or
+//! -   is built so that both the curve and this solution are external to one another, or
+//! -   is undefined (all solutions apply).
+//! These package methods provide simpler functions to construct a qualified curve.
+//! Note: the interior of a curve is defined as the left-hand
+//! side of the curve in relation to its orientation.
+class Geom2dGcc 
+{
+public:
+
+  DEFINE_STANDARD_ALLOC
+
+  
+  //! Constructs such a qualified curve that the relative
+  //! position of the solution computed by a construction
+  //! algorithm using the qualified curve to the circle or line is
+  //! not qualified, i.e. all solutions apply.
+  //! Warning
+  //! Obj is an adapted curve, i.e. an object which is an interface between:
+  //! -   the services provided by a 2D curve from the package Geom2d,
+  //! -   and those required on the curve by a computation algorithm.
+  //! The adapted curve is created in the following way:
+  //! Handle(Geom2d_Curve) mycurve = ...
+  //! ;
+  //! Geom2dAdaptor_Curve Obj ( mycurve )
+  //! ;
+  //! The qualified curve is then constructed with this object:
+  //! Geom2dGcc_QualifiedCurve
+  //! myQCurve = Geom2dGcc::Unqualified(Obj);
+  Standard_EXPORT static Geom2dGcc_QualifiedCurve Unqualified (const Geom2dAdaptor_Curve& Obj);
+  
+  //! Constructs such a qualified curve that the solution
+  //! computed by a construction algorithm using the qualified
+  //! curve encloses the curve.
+  //! Warning
+  //! Obj is an adapted curve, i.e. an object which is an interface between:
+  //! -   the services provided by a 2D curve from the package Geom2d,
+  //! -   and those required on the curve by a computation algorithm.
+  //! The adapted curve is created in the following way:
+  //! Handle(Geom2d_Curve) mycurve = ...
+  //! ;
+  //! Geom2dAdaptor_Curve Obj ( mycurve )
+  //! ;
+  //! The qualified curve is then constructed with this object:
+  //! Geom2dGcc_QualifiedCurve
+  //! myQCurve = Geom2dGcc::Enclosing(Obj);
+  Standard_EXPORT static Geom2dGcc_QualifiedCurve Enclosing (const Geom2dAdaptor_Curve& Obj);
+  
+  //! Constructs such a qualified curve that the solution
+  //! computed by a construction algorithm using the qualified
+  //! curve is enclosed by the curve.
+  //! Warning
+  //! Obj is an adapted curve, i.e. an object which is an interface between:
+  //! -   the services provided by a 2D curve from the package Geom2d,
+  //! -   and those required on the curve by a computation algorithm.
+  //! The adapted curve is created in the following way:
+  //! Handle(Geom2d_Curve) mycurve = ...
+  //! ;
+  //! Geom2dAdaptor_Curve Obj ( mycurve )
+  //! ;
+  //! The qualified curve is then constructed with this object:
+  //! Geom2dGcc_QualifiedCurve
+  //! myQCurve = Geom2dGcc::Enclosed(Obj);
+  Standard_EXPORT static Geom2dGcc_QualifiedCurve Enclosed (const Geom2dAdaptor_Curve& Obj);
+  
+  //! Constructs such a qualified curve that the solution
+  //! computed by a construction algorithm using the qualified
+  //! curve and the curve are external to one another.
+  //! Warning
+  //! Obj is an adapted curve, i.e. an object which is an interface between:
+  //! -   the services provided by a 2D curve from the package Geom2d,
+  //! -   and those required on the curve by a computation algorithm.
+  //! The adapted curve is created in the following way:
+  //! Handle(Geom2d_Curve) mycurve = ...
+  //! ;
+  //! Geom2dAdaptor_Curve Obj ( mycurve )
+  //! ;
+  //! The qualified curve is then constructed with this object:
+  //! Geom2dGcc_QualifiedCurve
+  //! myQCurve = Geom2dGcc::Outside(Obj);
+  Standard_EXPORT static Geom2dGcc_QualifiedCurve Outside (const Geom2dAdaptor_Curve& Obj);
+
+
+
+
+protected:
+
+
+
+
+
+private:
+
+
+
+
+friend class Geom2dGcc_CurveTool;
+friend class Geom2dGcc_QualifiedCurve;
+friend class Geom2dGcc_Circ2d3Tan;
+friend class Geom2dGcc_Circ2d2TanRad;
+friend class Geom2dGcc_Circ2d2TanOn;
+friend class Geom2dGcc_Circ2dTanOnRad;
+friend class Geom2dGcc_Circ2dTanCen;
+friend class Geom2dGcc_Lin2d2Tan;
+friend class Geom2dGcc_Lin2dTanObl;
+friend class Geom2dGcc_QCurve;
+friend class Geom2dGcc_CurveToolGeo;
+friend class Geom2dGcc_Circ2d2TanOnGeo;
+friend class Geom2dGcc_Circ2d2TanRadGeo;
+friend class Geom2dGcc_Circ2dTanCenGeo;
+friend class Geom2dGcc_Circ2dTanOnRadGeo;
+friend class Geom2dGcc_Circ2d3TanIter;
+friend class Geom2dGcc_FunctionTanCuCuCu;
+friend class Geom2dGcc_Circ2d2TanOnIter;
+friend class Geom2dGcc_FunctionTanCuCuOnCu;
+friend class Geom2dGcc_Lin2dTanOblIter;
+friend class Geom2dGcc_FunctionTanObl;
+friend class Geom2dGcc_Lin2d2TanIter;
+friend class Geom2dGcc_FunctionTanCuCu;
+friend class Geom2dGcc_FunctionTanCuPnt;
+friend class Geom2dGcc_FunctionTanCirCu;
+
+};
+
+
+
+
+
+
+
+#endif // _Geom2dGcc_HeaderFile