EIC code displayed by LXR master/​include/​opencascade/​GC_MakeHyperbola.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:03:31

 // 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_MakeHyperbola_HeaderFile
 #define _GC_MakeHyperbola_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_DefineAlloc.hxx>
 #include <Standard_Handle.hxx>
 
 #include <GC_Root.hxx>
 #include <Geom_Hyperbola.hxx>
 
 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;
 
   operator const Handle(Geom_Hyperbola)& () const { return Value(); }
 
 private:
   Handle(Geom_Hyperbola) TheHyperbola;
 };
 
 #endif // _GC_MakeHyperbola_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team