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

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

 // Created on: 1992-08-26
 // 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 _gce_MakeHypr2d_HeaderFile
 #define _gce_MakeHypr2d_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_DefineAlloc.hxx>
 #include <Standard_Handle.hxx>
 
 #include <gp_Hypr2d.hxx>
 #include <gce_Root.hxx>
 #include <Standard_Boolean.hxx>
 class gp_Pnt2d;
 class gp_Ax2d;
 class gp_Ax22d;
 
 
 //! This class implements the following algorithms used to
 //! create a 2d Hyperbola from gp.
 //! * Create a 2d Hyperbola from its center and two points:
 //! one on its axis of symmetry giving the major radius, the
 //! other giving the value of the small radius.
 //! * Create a 2d Hyperbola from its major axis and its major
 //! radius and its minor radius.
 //!
 //! ^YAxis
 //! |
 //! FirstConjugateBranch
 //! |
 //! Other            |                Main
 //! --------------------- C ------------------------------>XAxis
 //! Branch           |                Branch
 //! |
 //! |
 //! SecondConjugateBranch
 //! |
 //!
 //! An axis placement (one axis) is associated with the hyperbola.
 //! This axis is the "XAxis" or major axis of the hyperbola. It is
 //! the symmetry axis of the main branch of hyperbola.
 //! The "YAxis" is normal to this axis and pass through its location
 //! point. It is the minor axis.
 //!
 //! The major radius is the distance between the Location point
 //! of the hyperbola C and the vertex of the Main Branch (or the
 //! Other branch). The minor radius is the distance between the
 //! Location point of the hyperbola C and the vertex of the First
 //! (or Second) Conjugate branch.
 //! The major radius can be lower than the minor radius.
 class gce_MakeHypr2d  : public gce_Root
 {
 public:
 
   DEFINE_STANDARD_ALLOC
 
   
   //! Constructs a hyperbola
   //! centered on the point Center, where:
   //! -   the major axis of the hyperbola is defined by Center and point S1,
   //! -   the major radius is the distance between Center and S1, and
   //! -   the minor radius is the distance between point S2 and the major axis.
   Standard_EXPORT gce_MakeHypr2d(const gp_Pnt2d& S1, const gp_Pnt2d& S2, const gp_Pnt2d& Center);
   
   //! Constructs a hyperbola with major and minor radii MajorRadius and
   //! MinorRadius, where:
   //! -   the center of the hyperbola is the origin of the axis MajorAxis, and
   //! -   the major axis is defined by MajorAxis if Sense
   //! is true, or the opposite axis to MajorAxis if Sense is false; or
   //! -   centered on the origin of the coordinate system
   //! A, with major and minor radii MajorRadius and
   //! MinorRadius, where its major axis is the "X Axis"
   //! of A (A is the local coordinate system of the hyperbola).
   Standard_EXPORT gce_MakeHypr2d(const gp_Ax2d& MajorAxis, const Standard_Real MajorRadius, const Standard_Real MinorRadius, const Standard_Boolean Sense);
   
   //! Creates a Hypr2d centered on the origin of the coordinate system
   //! A, with major and minor radii MajorRadius and
   //! MinorRadius, where its major axis is the "X Axis"
   //! of A (A is the local coordinate system of the hyperbola).
   Standard_EXPORT gce_MakeHypr2d(const gp_Ax22d& A, const Standard_Real MajorRadius, const Standard_Real MinorRadius);
   
   //! Returns the constructed hyperbola.
   //! Exceptions StdFail_NotDone if no hyperbola is constructed.
   Standard_EXPORT const gp_Hypr2d& Value() const;
   
   Standard_EXPORT const gp_Hypr2d& Operator() const;
 Standard_EXPORT operator gp_Hypr2d() const;
 
 
 
 
 protected:
 
 
 
 
 
 private:
 
 
 
   gp_Hypr2d TheHypr2d;
 
 
 };
 
 
 
 
 
 
 
 #endif // _gce_MakeHypr2d_HeaderFile

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