EIC code displayed by LXR master/​include/​opencascade/​gce_MakeElips2d.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_MakeElips2d_HeaderFile
 #define _gce_MakeElips2d_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_DefineAlloc.hxx>
 #include <Standard_Handle.hxx>
 
 #include <gp_Elips2d.hxx>
 #include <gce_Root.hxx>
 #include <Standard_Boolean.hxx>
 class gp_Ax2d;
 class gp_Ax22d;
 class gp_Pnt2d;
 
 
 //! This class implements the following algorithms used to
 //! create Elips2d from gp.
 //!
 //! * Create an ellipse from its center, and two points:
 //! one on the ciconference giving the major radius, the
 //! other giving the value of the small radius.
 //! * Create an ellipse from its major axis and its major
 //! radius and its minor radius.
 class gce_MakeElips2d  : public gce_Root
 {
 public:
 
   DEFINE_STANDARD_ALLOC
 
   
 
   //! Creates an ellipse with the major axis, the major and the
   //! minor radius. The location of the MajorAxis is the center
   //! of the  ellipse.
   //! The sense of parametrization is given by Sense.
   //! It is possible to create an ellipse with MajorRadius = MinorRadius.
   //! the status is "InvertRadius" if MajorRadius < MinorRadius or
   //! "NegativeRadius" if MinorRadius < 0.0
   Standard_EXPORT gce_MakeElips2d(const gp_Ax2d& MajorAxis, const Standard_Real MajorRadius, const Standard_Real MinorRadius, const Standard_Boolean Sense = Standard_True);
   
 
   //! Axis defines the Xaxis and Yaxis of the ellipse which defines
   //! the origin and the sense of parametrization.
   //! Creates an ellipse with the AxisPlacement the major and the
   //! minor radius. The location of Axis is the center
   //! of the  ellipse.
   //! It is possible to create an ellipse with MajorRadius = MinorRadius.
   //! the status is "InvertRadius" if MajorRadius < MinorRadius or
   //! "NegativeRadius" if MinorRadius < 0.0
   Standard_EXPORT gce_MakeElips2d(const gp_Ax22d& A, const Standard_Real MajorRadius, const Standard_Real MinorRadius);
   
   //! Makes an Elips2d with its center and two points.
   //! The sense of parametrization is given by S1, S2,
   //! and Center.
   //! Depending on the constructor, the  implicit orientation of the ellipse is:
   //! -   the sense defined by A,
   //! -   the sense defined by points Center, S1 and S2,
   //! -   the trigonometric sense if Sense is not given or is true, or
   //! -   the opposite if Sense is false.
   //! It is possible to construct an ellipse where the major
   //! and minor radii are equal.
   //! Warning
   //! If an error occurs (that is, when IsDone returns
   //! false), the Status function returns:
   //! -   gce_InvertRadius if MajorRadius is less than MinorRadius,
   //! -   gce_NegativeRadius if MajorRadius or
   //! MinorRadius is less than 0.0,
   //! -   gce_NullAxis if points S1, S2 and Center are collinear, or
   //! -   gce_InvertAxis if the major radius computed with
   //! Center and S1 is less than the minor radius
   //! computed with Center, S1 and S2.
   Standard_EXPORT gce_MakeElips2d(const gp_Pnt2d& S1, const gp_Pnt2d& S2, const gp_Pnt2d& Center);
   
   //! Returns the constructed ellipse.
   //! Exceptions StdFail_NotDone if no ellipse is constructed.
   Standard_EXPORT const gp_Elips2d& Value() const;
   
   Standard_EXPORT const gp_Elips2d& Operator() const;
 Standard_EXPORT operator gp_Elips2d() const;
 
 
 
 
 protected:
 
 
 
 
 
 private:
 
 
 
   gp_Elips2d TheElips2d;
 
 
 };
 
 
 
 
 
 
 
 #endif // _gce_MakeElips2d_HeaderFile

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