include/opencascade/GC_MakeSegment.hxx

0001 // Created on: 1992-09-28
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-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 _GC_MakeSegment_HeaderFile
0018 #define _GC_MakeSegment_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GC_Root.hxx>
0025 #include <Geom_TrimmedCurve.hxx>
0026
0027 class gp_Pnt;
0028 class gp_Lin;
0029
0030
0031 //! Implements construction algorithms for a line
0032 //! segment in 3D space.
0033 //! Makes a segment of Line from the 2 points <P1> and <P2>.
0034 //! The result is a Geom_TrimmedCurve curve.
0035 //! A MakeSegment object provides a framework for:
0036 //! -   defining the construction of the line segment,
0037 //! -   implementing the construction algorithm, and
0038 //! -   consulting the results. In particular, the Value
0039 //! function returns the constructed line segment.
0040 class GC_MakeSegment  : public GC_Root
0041 {
0042 public:
0043
0044   DEFINE_STANDARD_ALLOC
0045
0046
0047   //! Make a segment of Line from the 2 points <P1> and <P2>.
0048   //! It returns NullObject if <P1> and <P2> are confused.
0049   Standard_EXPORT GC_MakeSegment(const gp_Pnt& P1, const gp_Pnt& P2);
0050
0051   //! Make a segment of Line from the line <Line1>
0052   //! between the two parameters U1 and U2.
0053   //! It returns NullObject if <U1> is equal <U2>.
0054   Standard_EXPORT GC_MakeSegment(const gp_Lin& Line, const Standard_Real U1, const Standard_Real U2);
0055
0056   //! Make a segment of Line from the line <Line1>
0057   //! between the point <Point> and the parameter Ulast.
0058   //! It returns NullObject if <U1> is equal <U2>.
0059   Standard_EXPORT GC_MakeSegment(const gp_Lin& Line, const gp_Pnt& Point, const Standard_Real Ulast);
0060
0061   //! Make a segment of Line from the line <Line1>
0062   //! between the two points <P1> and <P2>.
0063   //! It returns NullObject if <U1> is equal <U2>.
0064   Standard_EXPORT GC_MakeSegment(const gp_Lin& Line, const gp_Pnt& P1, const gp_Pnt& P2);
0065
0066   //! Returns the constructed line segment.
0067   Standard_EXPORT const Handle(Geom_TrimmedCurve)& Value() const;
0068
0069   operator const Handle(Geom_TrimmedCurve)& () const { return Value(); }
0070
0071 private:
0072   Handle(Geom_TrimmedCurve) TheSegment;
0073 };
0074
0075 #endif // _GC_MakeSegment_HeaderFile