src/GCE2d/GCE2d_MakeSegment.hxx

   1 // Created on: 1992-09-28
   2 // Created by: Remi GILET
   3 // Copyright (c) 1992-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 _GCE2d_MakeSegment_HeaderFile
  18 #define _GCE2d_MakeSegment_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <GCE2d_Root.hxx>
  25 #include <Geom2d_TrimmedCurve.hxx>
  26
  27 class gp_Pnt2d;
  28 class gp_Dir2d;
  29 class gp_Lin2d;
  30
  31
  32 //! Implements construction algorithms for a line
  33 //! segment in the plane. The result is a
  34 //! Geom2d_TrimmedCurve curve.
  35 //! A MakeSegment object provides a framework for:
  36 //! -   defining the construction of the line segment,
  37 //! -   implementing the construction algorithm, and
  38 //! -   consulting the results. In particular, the Value
  39 //! function returns the constructed line segment.
  40 class GCE2d_MakeSegment  : public GCE2d_Root
  41 {
  42 public:
  43
  44   DEFINE_STANDARD_ALLOC
  45
  46
  47   //! Make a segment of Line from the 2 points <P1> and <P2>.
  48   //! Status is "ConfusedPoints" if <P1> and <P2> are confused.
  49   Standard_EXPORT GCE2d_MakeSegment(const gp_Pnt2d& P1, const gp_Pnt2d& P2);
  50
  51   //! Make a segment of Line from the point <P1> with
  52   //! the direction <P> and ended by the projection of
  53   //! <P2> on the line <P1,V>.
  54   //! Status is "ConfusedPoints" if <P1> and <P2> are confused.
  55   Standard_EXPORT GCE2d_MakeSegment(const gp_Pnt2d& P1, const gp_Dir2d& V, const gp_Pnt2d& P2);
  56
  57   //! Make a segment of Line from the line <Line>
  58   //! between the two parameters U1 and U2.
  59   //! Status is "SameParameters" if <U1> is equal <U2>.
  60   Standard_EXPORT GCE2d_MakeSegment(const gp_Lin2d& Line, const Standard_Real U1, const Standard_Real U2);
  61
  62   //! Make a segment of Line from the line <Line>
  63   //! between the point <Point> and the parameter Ulast.
  64   //! It returns NullObject if <U1> is equal <U2>.
  65   Standard_EXPORT GCE2d_MakeSegment(const gp_Lin2d& Line, const gp_Pnt2d& Point, const Standard_Real Ulast);
  66
  67   //! Make a segment of Line from the line <Line>
  68   //! between the two points <P1> and <P2>.
  69   //! It returns NullObject if <P1> and <P2> are confused.
  70   //! Warning
  71   //! If the points which limit the segment are coincident
  72   //! for given points or for the projection of given points
  73   //! on the line which supports the line segment (that is,
  74   //! when IsDone returns false), the Status function
  75   //! returns gce_ConfusedPoints. This warning only
  76   //! concerns the first two constructors.
  77   Standard_EXPORT GCE2d_MakeSegment(const gp_Lin2d& Line, const gp_Pnt2d& P1, const gp_Pnt2d& P2);
  78
  79   //! Returns the constructed line segment.
  80   //! Exceptions StdFail_NotDone if no line segment is constructed.
  81   Standard_EXPORT const Handle(Geom2d_TrimmedCurve)& Value() const;
  82
  83   operator const Handle(Geom2d_TrimmedCurve)& () const { return Value(); }
  84
  85 private:
  86   Handle(Geom2d_TrimmedCurve) TheSegment;
  87 };
  88
  89 #endif // _GCE2d_MakeSegment_HeaderFile