include/opencascade/GccEnt_QualifiedCirc.hxx

0001 // Created on: 1991-04-15
0002 // Created by: Philippe DAUTRY
0003 // Copyright (c) 1991-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 _GccEnt_QualifiedCirc_HeaderFile
0018 #define _GccEnt_QualifiedCirc_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gp_Circ2d.hxx>
0025 #include <GccEnt_Position.hxx>
0026 #include <Standard_Boolean.hxx>
0027
0028 //! Creates a qualified 2d Circle.
0029 //! A qualified 2D circle is a circle (gp_Circ2d circle) with a
0030 //! qualifier which specifies whether the solution of a
0031 //! construction algorithm using the qualified circle (as an argument):
0032 //! -   encloses the circle, or
0033 //! -   is enclosed by the circle, or
0034 //! -   is built so that both the circle and it are external to one another, or
0035 //! -   is undefined (all solutions apply).
0036 class GccEnt_QualifiedCirc
0037 {
0038 public:
0039   DEFINE_STANDARD_ALLOC
0040
0041   //! Constructs a qualified circle by assigning the qualifier
0042   //! Qualifier to the circle Qualified. Qualifier may be:
0043   //! -   GccEnt_enclosing if the solution computed by a
0044   //! construction algorithm using the qualified circle
0045   //! encloses the circle, or
0046   //! -   GccEnt_enclosed if the solution is enclosed by the circle, or
0047   //! -   GccEnt_outside if both the solution and the circle
0048   //! are external to one another, or
0049   //! -   GccEnt_unqualified if all solutions apply.
0050   Standard_EXPORT GccEnt_QualifiedCirc(const gp_Circ2d& Qualified, const GccEnt_Position Qualifier);
0051
0052   //! Returns a 2D circle to which the qualifier is assigned.
0053   Standard_EXPORT gp_Circ2d Qualified() const;
0054
0055   //! Returns
0056   //! -   the qualifier of this qualified circle, if it is enclosing,
0057   //! enclosed or outside, or
0058   //! -   GccEnt_noqualifier if it is unqualified.
0059   Standard_EXPORT GccEnt_Position Qualifier() const;
0060
0061   //! Returns true if the Circ2d is Unqualified and false in
0062   //! the other cases.
0063   Standard_EXPORT bool IsUnqualified() const;
0064
0065   //! Returns true if the solution computed by a construction
0066   //! algorithm using this qualified circle encloses the circle.
0067   Standard_EXPORT bool IsEnclosing() const;
0068
0069   //! Returns true if the solution computed by a construction
0070   //! algorithm using this qualified circle is enclosed by the circle.
0071   Standard_EXPORT bool IsEnclosed() const;
0072
0073   //! Returns true if both the solution computed by a
0074   //! construction algorithm using this qualified circle and the
0075   //! circle are external to one another.
0076   Standard_EXPORT bool IsOutside() const;
0077
0078 private:
0079   gp_Circ2d       TheQualified;
0080   GccEnt_Position TheQualifier;
0081 };
0082
0083 #endif // _GccEnt_QualifiedCirc_HeaderFile