src/GccEnt/GccEnt_QualifiedLin.hxx

   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_QualifiedLin_HeaderFile
  18 #define _GccEnt_QualifiedLin_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <GccEnt_Position.hxx>
  25 #include <gp_Lin2d.hxx>
  26 #include <Standard_Boolean.hxx>
  27 class gp_Lin2d;
  28
  29
  30 //! Describes a qualified 2D line.
  31 //! A qualified 2D line is a line (gp_Lin2d line) with a
  32 //! qualifier which specifies whether the solution of a
  33 //! construction algorithm using the qualified line (as an argument):
  34 //! -   is 'enclosed' by the line, or
  35 //! -   is built so that both the line and it are external to one another, or
  36 //! -   is undefined (all solutions apply).
  37 //! Note: the interior of a line is defined as the left-hand
  38 //! side of the line in relation to its orientation (i.e. when
  39 //! moving from the start to the end of the curve).
  40 class GccEnt_QualifiedLin
  41 {
  42 public:
  43
  44   DEFINE_STANDARD_ALLOC
  45
  46
  47
  48   //! Constructs a qualified line by assigning the qualifier
  49   //! Qualifier to the line Qualified.
  50   //! Qualifier may be:
  51   //! -   GccEnt_enclosed if the solution is enclosed by the line, or
  52   //! -   GccEnt_outside if both the solution and the line are external to one another, or
  53   //! -   GccEnt_unqualified if all solutions apply.
  54   //! Note : the interior of a line is defined as the left-hand
  55   //! side of the line in relation to its orientation.
  56   Standard_EXPORT GccEnt_QualifiedLin(const gp_Lin2d& Qualified, const GccEnt_Position Qualifier);
  57
  58   //! Returns a 2D line to which the qualifier is assigned.
  59   Standard_EXPORT gp_Lin2d Qualified() const;
  60
  61
  62   //! Returns the qualifier of this qualified line, if it is "enclosed" or
  63   //! "outside", or
  64   //! -   GccEnt_noqualifier if it is unqualified.
  65   Standard_EXPORT GccEnt_Position Qualifier() const;
  66
  67   //! Returns true if the solution is unqualified and false in
  68   //! the other cases.
  69   Standard_EXPORT Standard_Boolean IsUnqualified() const;
  70
  71   //! Returns true if the solution is Enclosed in the Lin2d and false in
  72   //! the other cases.
  73   Standard_EXPORT Standard_Boolean IsEnclosed() const;
  74
  75   //! Returns true if the solution is Outside the Lin2d and false in
  76   //! the other cases.
  77   Standard_EXPORT Standard_Boolean IsOutside() const;
  78
  79
  80
  81
  82 protected:
  83
  84
  85
  86
  87
  88 private:
  89
  90
  91
  92   GccEnt_Position TheQualifier;
  93   gp_Lin2d TheQualified;
  94
  95
  96 };
  97
  98
  99
 100
 101
 102
 103
 104 #endif // _GccEnt_QualifiedLin_HeaderFile