include/opencascade/GC_MakeSegment2d.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_MakeSegment2d_HeaderFile
0018 #define _GC_MakeSegment2d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GC_Root.hxx>
0025 #include <Geom2d_TrimmedCurve.hxx>
0026
0027 class gp_Pnt2d;
0028 class gp_Dir2d;
0029 class gp_Lin2d;
0030
0031 //! This class implements construction algorithms for line segments in the plane.
0032 //! The result is a `Geom2d_TrimmedCurve`.
0033 //! A `GC_MakeSegment2d` object provides a framework for:
0034 //! - defining the construction parameters;
0035 //! - running the construction algorithm;
0036 //! - querying the construction status and the resulting segment via `Value()`.
0037 class GC_MakeSegment2d : public GC_Root
0038 {
0039 public:
0040   DEFINE_STANDARD_ALLOC
0041
0042   //! Creates a segment between two points.
0043   //! @param[in] theP1 first point
0044   //! @param[in] theP2 second point
0045   //! @note Construction fails with `gce_ConfusedPoints` if points are coincident.
0046   Standard_EXPORT GC_MakeSegment2d(const gp_Pnt2d& theP1, const gp_Pnt2d& theP2);
0047
0048   //! Creates a segment on a line defined by point and direction.
0049   //! The segment starts at `theP1` and ends at the orthogonal projection
0050   //! of `theP2` onto that line.
0051   //! @param[in] theP1 first point
0052   //! @param[in] theV direction vector
0053   //! @param[in] theP2 second point
0054   //! @note Construction fails with `gce_ConfusedPoints` if the projected
0055   //!       endpoint is coincident with `theP1` within resolution.
0056   Standard_EXPORT GC_MakeSegment2d(const gp_Pnt2d& theP1,
0057                                    const gp_Dir2d& theV,
0058                                    const gp_Pnt2d& theP2);
0059
0060   //! Creates a segment on a line between two parameter values.
0061   //! @param[in] theLine source line
0062   //! @param[in] theU1 first parameter
0063   //! @param[in] theU2 second parameter
0064   Standard_EXPORT GC_MakeSegment2d(const gp_Lin2d& theLine, const double theU1, const double theU2);
0065
0066   //! Creates a segment on a line between point parameter and target parameter.
0067   //! @param[in] theLine source line
0068   //! @param[in] thePoint first point on segment support line
0069   //! @param[in] theUlast last parameter
0070   Standard_EXPORT GC_MakeSegment2d(const gp_Lin2d& theLine,
0071                                    const gp_Pnt2d& thePoint,
0072                                    const double    theUlast);
0073
0074   //! Creates a segment on a line between projections of two points.
0075   //! @param[in] theLine source line
0076   //! @param[in] theP1 first point
0077   //! @param[in] theP2 second point
0078   Standard_EXPORT GC_MakeSegment2d(const gp_Lin2d& theLine,
0079                                    const gp_Pnt2d& theP1,
0080                                    const gp_Pnt2d& theP2);
0081
0082   //! Returns the constructed line segment.
0083   //! Exceptions StdFail_NotDone if no line segment is constructed.
0084   //! @return resulting trimmed curve
0085   Standard_EXPORT const occ::handle<Geom2d_TrimmedCurve>& Value() const;
0086
0087   //! Conversion operator returning the constructed object.
0088   //! @return resulting trimmed curve
0089   operator const occ::handle<Geom2d_TrimmedCurve>&() const { return Value(); }
0090
0091 private:
0092   occ::handle<Geom2d_TrimmedCurve> TheSegment;
0093 };
0094
0095 #endif // _GC_MakeSegment2d_HeaderFile