Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2025-01-18 10:03:34

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