| 42cf5bc1 |
1 | // Created on: 1991-04-15 |
| 2 | // Created by: Philippe DAUTRY |
| 3 | // Copyright (c) 1991-1999 Matra Datavision |
| 4 | // Copyright (c) 1999-2014 OPEN CASCADE SAS |
| 5 | // |
| 6 | // This file is part of Open CASCADE Technology software library. |
| 7 | // |
| 8 | // This library is free software; you can redistribute it and/or modify it under |
| 9 | // the terms of the GNU Lesser General Public License version 2.1 as published |
| 10 | // by the Free Software Foundation, with special exception defined in the file |
| 11 | // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT |
| 12 | // distribution for complete text of the license and disclaimer of any warranty. |
| 13 | // |
| 14 | // Alternatively, this file may be used under the terms of Open CASCADE |
| 15 | // commercial license or contractual agreement. |
| 16 | |
| 17 | #ifndef _GccEnt_QualifiedCirc_HeaderFile |
| 18 | #define _GccEnt_QualifiedCirc_HeaderFile |
| 19 | |
| 20 | #include <Standard.hxx> |
| 21 | #include <Standard_DefineAlloc.hxx> |
| 22 | #include <Standard_Handle.hxx> |
| 23 | |
| 24 | #include <gp_Circ2d.hxx> |
| 25 | #include <GccEnt_Position.hxx> |
| 26 | #include <Standard_Boolean.hxx> |
| 42cf5bc1 |
27 | |
| 28 | |
| 29 | //! Creates a qualified 2d Circle. |
| 30 | //! A qualified 2D circle is a circle (gp_Circ2d circle) with a |
| 31 | //! qualifier which specifies whether the solution of a |
| 32 | //! construction algorithm using the qualified circle (as an argument): |
| 33 | //! - encloses the circle, or |
| 34 | //! - is enclosed by the circle, or |
| 35 | //! - is built so that both the circle and it are external to one another, or |
| 36 | //! - is undefined (all solutions apply). |
| 37 | class GccEnt_QualifiedCirc |
| 38 | { |
| 39 | public: |
| 40 | |
| 41 | DEFINE_STANDARD_ALLOC |
| 42 | |
| 43 | |
| 44 | //! Constructs a qualified circle by assigning the qualifier |
| 45 | //! Qualifier to the circle Qualified. Qualifier may be: |
| 46 | //! - GccEnt_enclosing if the solution computed by a |
| 47 | //! construction algorithm using the qualified circle |
| 48 | //! encloses the circle, or |
| 49 | //! - GccEnt_enclosed if the solution is enclosed by the circle, or |
| 50 | //! - GccEnt_outside if both the solution and the circle |
| 51 | //! are external to one another, or |
| 52 | //! - GccEnt_unqualified if all solutions apply. |
| 53 | Standard_EXPORT GccEnt_QualifiedCirc(const gp_Circ2d& Qualified, const GccEnt_Position Qualifier); |
| 54 | |
| 55 | //! Returns a 2D circle to which the qualifier is assigned. |
| 56 | Standard_EXPORT gp_Circ2d Qualified() const; |
| 57 | |
| 58 | //! Returns |
| 59 | //! - the qualifier of this qualified circle, if it is enclosing, |
| 60 | //! enclosed or outside, or |
| 61 | //! - GccEnt_noqualifier if it is unqualified. |
| 62 | Standard_EXPORT GccEnt_Position Qualifier() const; |
| 63 | |
| 64 | //! Returns true if the Circ2d is Unqualified and false in |
| 65 | //! the other cases. |
| 66 | Standard_EXPORT Standard_Boolean IsUnqualified() const; |
| 67 | |
| 68 | //! Returns true if the solution computed by a construction |
| 69 | //! algorithm using this qualified circle encloses the circle. |
| 70 | Standard_EXPORT Standard_Boolean IsEnclosing() const; |
| 71 | |
| 72 | //! Returns true if the solution computed by a construction |
| 73 | //! algorithm using this qualified circle is enclosed by the circle. |
| 74 | Standard_EXPORT Standard_Boolean IsEnclosed() const; |
| 75 | |
| 76 | //! Returns true if both the solution computed by a |
| 77 | //! construction algorithm using this qualified circle and the |
| 78 | //! circle are external to one another. |
| 79 | Standard_EXPORT Standard_Boolean IsOutside() const; |
| 80 | |
| 81 | |
| 82 | |
| 83 | |
| 84 | protected: |
| 85 | |
| 86 | |
| 87 | |
| 88 | |
| 89 | |
| 90 | private: |
| 91 | |
| 92 | |
| 93 | |
| 94 | gp_Circ2d TheQualified; |
| 95 | GccEnt_Position TheQualifier; |
| 96 | |
| 97 | |
| 98 | }; |
| 99 | |
| 100 | |
| 101 | |
| 102 | |
| 103 | |
| 104 | |
| 105 | |
| 106 | #endif // _GccEnt_QualifiedCirc_HeaderFile |
projects / occt.git / blame