OCCT

// Created on: 1992-09-28
// Created by: Remi GILET
// Copyright (c) 1992-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _GC_MakeLine_HeaderFile
#define _GC_MakeLine_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <GC_Root.hxx>
#include <Geom_Line.hxx>

class gp_Ax1;
class gp_Lin;
class gp_Pnt;
class gp_Dir;

//! This class implements the following algorithms used
//! to create a Line from Geom.
//! * Create a Line parallel to another and passing
//! through a point.
//! * Create a Line passing through 2 points.
//! A MakeLine object provides a framework for:
//! -   defining the construction of the line,
//! -   implementing the construction algorithm, and
//! -   consulting the results. In particular, the Value
//! function returns the constructed line.
class GC_MakeLine : public GC_Root
{
public:
  DEFINE_STANDARD_ALLOC

  //! Creates a line located in 3D space with the axis placement A1.
  //! @param[in] theA1 line axis placement
  //! @note The location of `theA1` is the origin of the line.
  Standard_EXPORT GC_MakeLine(const gp_Ax1& theA1);

  //! Creates a line from a non-persistent line from package gp.
  //! @param[in] theL source line
  Standard_EXPORT GC_MakeLine(const gp_Lin& theL);

  //! Creates a line from point and direction.
  //! @param[in] theP line origin
  //! @param[in] theV line direction
  Standard_EXPORT GC_MakeLine(const gp_Pnt& theP, const gp_Dir& theV);

  //! Creates a line parallel to the input line and passing through the input point.
  //! @param[in] theLin source line
  //! @param[in] thePoint point on resulting line
  Standard_EXPORT GC_MakeLine(const gp_Lin& theLin, const gp_Pnt& thePoint);

  //! Creates a line passing through two points.
  //! @param[in] theP1 first point
  //! @param[in] theP2 second point
  //! @note Construction fails with `gce_ConfusedPoints` if the two points are coincident.
  Standard_EXPORT GC_MakeLine(const gp_Pnt& theP1, const gp_Pnt& theP2);

  //! Returns the constructed line.
  //! Exceptions StdFail_NotDone if no line is constructed.
  //! @return resulting line
  Standard_EXPORT const occ::handle<Geom_Line>& Value() const;

  //! Conversion operator returning the constructed object.
  //! @return resulting object
  operator const occ::handle<Geom_Line>&() const { return Value(); }

private:
  occ::handle<Geom_Line> TheLine;
};

#endif // _GC_MakeLine_HeaderFile