src/GC/GC_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 _GC_MakeSegment_HeaderFile
  18 #define _GC_MakeSegment_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <GC_Root.hxx>
  25 #include <Geom_TrimmedCurve.hxx>
  26
  27 class StdFail_NotDone;
  28 class gp_Pnt;
  29 class gp_Lin;
  30
  31
  32 //! Implements construction algorithms for a line
  33 //! segment in 3D space.
  34 //! Makes a segment of Line from the 2 points <P1> and <P2>.
  35 //! The result is a Geom_TrimmedCurve curve.
  36 //! A MakeSegment object provides a framework for:
  37 //! -   defining the construction of the line segment,
  38 //! -   implementing the construction algorithm, and
  39 //! -   consulting the results. In particular, the Value
  40 //! function returns the constructed line segment.
  41 class GC_MakeSegment  : public GC_Root
  42 {
  43 public:
  44
  45   DEFINE_STANDARD_ALLOC
  46
  47
  48   //! Make a segment of Line from the 2 points <P1> and <P2>.
  49   //! It returns NullObject if <P1> and <P2> are confused.
  50   Standard_EXPORT GC_MakeSegment(const gp_Pnt& P1, const gp_Pnt& P2);
  51
  52   //! Make a segment of Line from the line <Line1>
  53   //! between the two parameters U1 and U2.
  54   //! It returns NullObject if <U1> is equal <U2>.
  55   Standard_EXPORT GC_MakeSegment(const gp_Lin& Line, const Standard_Real U1, const Standard_Real U2);
  56
  57   //! Make a segment of Line from the line <Line1>
  58   //! between the point <Point> and the parameter Ulast.
  59   //! It returns NullObject if <U1> is equal <U2>.
  60   Standard_EXPORT GC_MakeSegment(const gp_Lin& Line, const gp_Pnt& Point, const Standard_Real Ulast);
  61
  62   //! Make a segment of Line from the line <Line1>
  63   //! between the two points <P1> and <P2>.
  64   //! It returns NullObject if <U1> is equal <U2>.
  65   Standard_EXPORT GC_MakeSegment(const gp_Lin& Line, const gp_Pnt& P1, const gp_Pnt& P2);
  66
  67   //! Returns the constructed line segment.
  68   Standard_EXPORT const Handle(Geom_TrimmedCurve)& Value() const;
  69
  70   operator const Handle(Geom_TrimmedCurve)& () const { return Value(); }
  71
  72 private:
  73   Handle(Geom_TrimmedCurve) TheSegment;
  74 };
  75
  76 #endif // _GC_MakeSegment_HeaderFile