include/opencascade/GCE2d_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 _GCE2d_MakeSegment_HeaderFile
0018 #define _GCE2d_MakeSegment_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GCE2d_Root.hxx>
0025 #include <Geom2d_TrimmedCurve.hxx>
0026
0027 class gp_Pnt2d;
0028 class gp_Dir2d;
0029 class gp_Lin2d;
0030
0031
0032 //! Implements construction algorithms for a line
0033 //! segment in the plane. The result is a
0034 //! Geom2d_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 GCE2d_MakeSegment  : public GCE2d_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   //! Status is "ConfusedPoints" if <P1> and <P2> are confused.
0049   Standard_EXPORT GCE2d_MakeSegment(const gp_Pnt2d& P1, const gp_Pnt2d& P2);
0050
0051   //! Make a segment of Line from the point <P1> with
0052   //! the direction <P> and ended by the projection of
0053   //! <P2> on the line <P1,V>.
0054   //! Status is "ConfusedPoints" if <P1> and <P2> are confused.
0055   Standard_EXPORT GCE2d_MakeSegment(const gp_Pnt2d& P1, const gp_Dir2d& V, const gp_Pnt2d& P2);
0056
0057   //! Make a segment of Line from the line <Line>
0058   //! between the two parameters U1 and U2.
0059   //! Status is "SameParameters" if <U1> is equal <U2>.
0060   Standard_EXPORT GCE2d_MakeSegment(const gp_Lin2d& Line, const Standard_Real U1, const Standard_Real U2);
0061
0062   //! Make a segment of Line from the line <Line>
0063   //! between the point <Point> and the parameter Ulast.
0064   //! It returns NullObject if <U1> is equal <U2>.
0065   Standard_EXPORT GCE2d_MakeSegment(const gp_Lin2d& Line, const gp_Pnt2d& Point, const Standard_Real Ulast);
0066
0067   //! Make a segment of Line from the line <Line>
0068   //! between the two points <P1> and <P2>.
0069   //! It returns NullObject if <P1> and <P2> are confused.
0070   //! Warning
0071   //! If the points which limit the segment are coincident
0072   //! for given points or for the projection of given points
0073   //! on the line which supports the line segment (that is,
0074   //! when IsDone returns false), the Status function
0075   //! returns gce_ConfusedPoints. This warning only
0076   //! concerns the first two constructors.
0077   Standard_EXPORT GCE2d_MakeSegment(const gp_Lin2d& Line, const gp_Pnt2d& P1, const gp_Pnt2d& P2);
0078
0079   //! Returns the constructed line segment.
0080   //! Exceptions StdFail_NotDone if no line segment is constructed.
0081   Standard_EXPORT const Handle(Geom2d_TrimmedCurve)& Value() const;
0082
0083   operator const Handle(Geom2d_TrimmedCurve)& () const { return Value(); }
0084
0085 private:
0086   Handle(Geom2d_TrimmedCurve) TheSegment;
0087 };
0088
0089 #endif // _GCE2d_MakeSegment_HeaderFile