include/opencascade/Geom2dGcc.hxx

0001 // Created on: 1992-06-29
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-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 _Geom2dGcc_HeaderFile
0018 #define _Geom2dGcc_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 class Geom2dGcc_QualifiedCurve;
0025 class Geom2dAdaptor_Curve;
0026
0027 //! The Geom2dGcc package describes qualified 2D
0028 //! curves used in the construction of constrained geometric
0029 //! objects by an algorithm provided by the Geom2dGcc package.
0030 //! A qualified 2D curve is a curve with a qualifier which
0031 //! specifies whether the solution of a construction
0032 //! algorithm using the qualified curve (as an argument):
0033 //! -   encloses the curve, or
0034 //! -   is enclosed by the curve, or
0035 //! -   is built so that both the curve and this solution are external to one another, or
0036 //! -   is undefined (all solutions apply).
0037 //! These package methods provide simpler functions to construct a qualified curve.
0038 //! Note: the interior of a curve is defined as the left-hand
0039 //! side of the curve in relation to its orientation.
0040 class Geom2dGcc
0041 {
0042 public:
0043   DEFINE_STANDARD_ALLOC
0044
0045   //! Constructs such a qualified curve that the relative
0046   //! position of the solution computed by a construction
0047   //! algorithm using the qualified curve to the circle or line is
0048   //! not qualified, i.e. all solutions apply.
0049   //! Warning
0050   //! Obj is an adapted curve, i.e. an object which is an interface between:
0051   //! -   the services provided by a 2D curve from the package Geom2d,
0052   //! -   and those required on the curve by a computation algorithm.
0053   //! The adapted curve is created in the following way:
0054   //! Handle(Geom2d_Curve) mycurve = ...
0055   //! ;
0056   //! Geom2dAdaptor_Curve Obj ( mycurve )
0057   //! ;
0058   //! The qualified curve is then constructed with this object:
0059   //! Geom2dGcc_QualifiedCurve
0060   //! myQCurve = Geom2dGcc::Unqualified(Obj);
0061   Standard_EXPORT static Geom2dGcc_QualifiedCurve Unqualified(const Geom2dAdaptor_Curve& Obj);
0062
0063   //! Constructs such a qualified curve that the solution
0064   //! computed by a construction algorithm using the qualified
0065   //! curve encloses the curve.
0066   //! Warning
0067   //! Obj is an adapted curve, i.e. an object which is an interface between:
0068   //! -   the services provided by a 2D curve from the package Geom2d,
0069   //! -   and those required on the curve by a computation algorithm.
0070   //! The adapted curve is created in the following way:
0071   //! Handle(Geom2d_Curve) mycurve = ...
0072   //! ;
0073   //! Geom2dAdaptor_Curve Obj ( mycurve )
0074   //! ;
0075   //! The qualified curve is then constructed with this object:
0076   //! Geom2dGcc_QualifiedCurve
0077   //! myQCurve = Geom2dGcc::Enclosing(Obj);
0078   Standard_EXPORT static Geom2dGcc_QualifiedCurve Enclosing(const Geom2dAdaptor_Curve& Obj);
0079
0080   //! Constructs such a qualified curve that the solution
0081   //! computed by a construction algorithm using the qualified
0082   //! curve is enclosed by the curve.
0083   //! Warning
0084   //! Obj is an adapted curve, i.e. an object which is an interface between:
0085   //! -   the services provided by a 2D curve from the package Geom2d,
0086   //! -   and those required on the curve by a computation algorithm.
0087   //! The adapted curve is created in the following way:
0088   //! Handle(Geom2d_Curve) mycurve = ...
0089   //! ;
0090   //! Geom2dAdaptor_Curve Obj ( mycurve )
0091   //! ;
0092   //! The qualified curve is then constructed with this object:
0093   //! Geom2dGcc_QualifiedCurve
0094   //! myQCurve = Geom2dGcc::Enclosed(Obj);
0095   Standard_EXPORT static Geom2dGcc_QualifiedCurve Enclosed(const Geom2dAdaptor_Curve& Obj);
0096
0097   //! Constructs such a qualified curve that the solution
0098   //! computed by a construction algorithm using the qualified
0099   //! curve and the curve are external to one another.
0100   //! Warning
0101   //! Obj is an adapted curve, i.e. an object which is an interface between:
0102   //! -   the services provided by a 2D curve from the package Geom2d,
0103   //! -   and those required on the curve by a computation algorithm.
0104   //! The adapted curve is created in the following way:
0105   //! Handle(Geom2d_Curve) mycurve = ...
0106   //! ;
0107   //! Geom2dAdaptor_Curve Obj ( mycurve )
0108   //! ;
0109   //! The qualified curve is then constructed with this object:
0110   //! Geom2dGcc_QualifiedCurve
0111   //! myQCurve = Geom2dGcc::Outside(Obj);
0112   Standard_EXPORT static Geom2dGcc_QualifiedCurve Outside(const Geom2dAdaptor_Curve& Obj);
0113 };
0114
0115 #endif // _Geom2dGcc_HeaderFile