// 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_MakeArcOfHyperbola_HeaderFile
#define _GC_MakeArcOfHyperbola_HeaderFile

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

#include <GC_Root.hxx>
#include <Geom_TrimmedCurve.hxx>

class gp_Hypr;
class gp_Pnt;

//! Implements construction algorithms for an arc
//! of hyperbola in 3D space. The result is a Geom_TrimmedCurve curve.
//! A MakeArcOfHyperbola object provides a framework for:
//! -   defining the construction of the arc of hyperbola,
//! -   implementing the construction algorithm, and
//! -   consulting the results. In particular, the
//! Value function returns the constructed arc of hyperbola.
class GC_MakeArcOfHyperbola : public GC_Root
{
public:
  DEFINE_STANDARD_ALLOC

  //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
  //! a Hyperbola between two parameters Alpha1 and Alpha2
  //! (given in radians).
  Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr,
                                        const double   Alpha1,
                                        const double   Alpha2,
                                        const bool     Sense);

  //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
  //! a Hyperbola between point <P> and the parameter
  //! Alpha (given in radians).
  Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr,
                                        const gp_Pnt&  P,
                                        const double   Alpha,
                                        const bool     Sense);

  //! Creates an arc of Hyperbola (TrimmedCurve from Geom) from
  //! a Hyperbola between two points P1 and P2.
  //! The orientation of the arc of hyperbola is:
  //! -   the sense of Hypr if Sense is true, or
  //! -   the opposite sense if Sense is false.
  Standard_EXPORT GC_MakeArcOfHyperbola(const gp_Hypr& Hypr,
                                        const gp_Pnt&  P1,
                                        const gp_Pnt&  P2,
                                        const bool     Sense);

  //! Returns the constructed arc of hyperbola.
  Standard_EXPORT const occ::handle<Geom_TrimmedCurve>& Value() const;

  operator const occ::handle<Geom_TrimmedCurve>&() const { return Value(); }

private:
  occ::handle<Geom_TrimmedCurve> TheArc;
};

#endif // _GC_MakeArcOfHyperbola_HeaderFile
