// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _GC_MakeHyperbola_HeaderFile
#define _GC_MakeHyperbola_HeaderFile

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

#include <Handle_Geom_Hyperbola.hxx>
#include <GC_Root.hxx>
#include <Standard_Real.hxx>
class Geom_Hyperbola;
class StdFail_NotDone;
class gp_Hypr;
class gp_Ax2;
class gp_Pnt;


//! This class implements construction algorithms for a hyperbola in
//! 3D space. The result is a Geom_Hyperbola hyperbola.
//! A MakeHyperbola object provides a framework for:
//! -   defining the construction of the hyperbola,
//! -   implementing the construction algorithm, and
//! -   consulting the results. In particular, the Value
//! function returns the constructed hyperbola.
//! To define the main branch of an hyperbola.
//! The parameterization range is ]-infinite,+infinite[
//! It is possible to get the other branch and the two conjugate
//! branches of the main branch.
//!
//! ^YAxis
//! |
//! FirstConjugateBranch
//! |
//! Other            |                Main
//! --------------------- C ------------------------------>XAxis
//! Branch           |                Branch
//! |
//! SecondConjugateBranch
//! |
//!
//! The major radius is the distance between the Location point
//! of the hyperbola C and the apex of the Main Branch (or the
//! Other branch). The major axis is the XAxis.
//! The minor radius is the distance between the Location point
//! of the hyperbola C and the apex of the First (or Second)
//! Conjugate branch. The minor axis is the YAxis.
//! The major radius can be lower than the minor radius.
class GC_MakeHyperbola  : public GC_Root
{
public:

  DEFINE_STANDARD_ALLOC

  

  //! Creates  an Hyperbola from a non persistent hyperbola  from package gp by conversion.
  Standard_EXPORT GC_MakeHyperbola(const gp_Hypr& H);
  
  //! Constructs a hyperbola centered on the origin of the coordinate system
  //! A2, with major and minor radii MajorRadius and MinorRadius, where:
  //! the plane of the hyperbola is defined by the "X Axis" and "Y Axis" of A2,
  //! -   its major axis is the "X Axis" of A2.
  Standard_EXPORT GC_MakeHyperbola(const gp_Ax2& A2, const Standard_Real MajorRadius, const Standard_Real MinorRadius);
  
  //! Constructs a hyperbola centered on the point Center, where
  //! -   the plane of the hyperbola is defined by Center, S1 and S2,
  //! -   its major axis is defined by Center and S1,
  //! -   its major radius is the distance between Center and S1, and
  //! -   its minor radius is the distance between S2 and the major axis;
  Standard_EXPORT GC_MakeHyperbola(const gp_Pnt& S1, const gp_Pnt& S2, const gp_Pnt& Center);
  
  //! Returns the constructed hyperbola.
  //! Exceptions StdFail_NotDone if no hyperbola is constructed.
  Standard_EXPORT  const  Handle(Geom_Hyperbola)& Value()  const;
  
  Standard_EXPORT  const  Handle(Geom_Hyperbola)& Operator()  const;
Standard_EXPORT operator Handle_Geom_Hyperbola() const;




protected:





private:



  Handle(Geom_Hyperbola) TheHyperbola;


};







#endif // _GC_MakeHyperbola_HeaderFile
