include/opencascade/GccEnt_QualifiedLin.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_QualifiedLin_HeaderFile
0018 #define _GccEnt_QualifiedLin_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GccEnt_Position.hxx>
0025 #include <gp_Lin2d.hxx>
0026 #include <Standard_Boolean.hxx>
0027
0028 //! Describes a qualified 2D line.
0029 //! A qualified 2D line is a line (gp_Lin2d line) with a
0030 //! qualifier which specifies whether the solution of a
0031 //! construction algorithm using the qualified line (as an argument):
0032 //! -   is 'enclosed' by the line, or
0033 //! -   is built so that both the line and it are external to one another, or
0034 //! -   is undefined (all solutions apply).
0035 //! Note: the interior of a line is defined as the left-hand
0036 //! side of the line in relation to its orientation (i.e. when
0037 //! moving from the start to the end of the curve).
0038 class GccEnt_QualifiedLin
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   //! Constructs a qualified line by assigning the qualifier
0044   //! Qualifier to the line Qualified.
0045   //! Qualifier may be:
0046   //! -   GccEnt_enclosed if the solution is enclosed by the line, or
0047   //! -   GccEnt_outside if both the solution and the line are external to one another, or
0048   //! -   GccEnt_unqualified if all solutions apply.
0049   //! Note : the interior of a line is defined as the left-hand
0050   //! side of the line in relation to its orientation.
0051   Standard_EXPORT GccEnt_QualifiedLin(const gp_Lin2d& Qualified, const GccEnt_Position Qualifier);
0052
0053   //! Returns a 2D line to which the qualifier is assigned.
0054   Standard_EXPORT gp_Lin2d Qualified() const;
0055
0056   //! Returns the qualifier of this qualified line, if it is "enclosed" or
0057   //! "outside", or
0058   //! -   GccEnt_noqualifier if it is unqualified.
0059   Standard_EXPORT GccEnt_Position Qualifier() const;
0060
0061   //! Returns true if the solution is unqualified and false in
0062   //! the other cases.
0063   Standard_EXPORT Standard_Boolean IsUnqualified() const;
0064
0065   //! Returns true if the solution is Enclosed in the Lin2d and false in
0066   //! the other cases.
0067   Standard_EXPORT Standard_Boolean IsEnclosed() const;
0068
0069   //! Returns true if the solution is Outside the Lin2d and false in
0070   //! the other cases.
0071   Standard_EXPORT Standard_Boolean IsOutside() const;
0072
0073 protected:
0074 private:
0075   GccEnt_Position TheQualifier;
0076   gp_Lin2d        TheQualified;
0077 };
0078
0079 #endif // _GccEnt_QualifiedLin_HeaderFile