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

File indexing completed on 2026-09-15 09:15:35

 // Created on: 1993-03-10
 // Created by: JCV
 // Copyright (c) 1993-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 _Geom_Circle_HeaderFile
 #define _Geom_Circle_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_Type.hxx>
 
 #include <Geom_Conic.hxx>
 class gp_Circ;
 class gp_Ax2;
 class gp_Trsf;
 class Geom_Geometry;
 
 //! Describes a circle in 3D space.
 //! A circle is defined by its radius and, as with any conic
 //! curve, is positioned in space with a right-handed
 //! coordinate system (gp_Ax2 object) where:
 //! - the origin is the center of the circle, and
 //! - the origin, "X Direction" and "Y Direction" define the
 //! plane of the circle.
 //! This coordinate system is the local coordinate
 //! system of the circle.
 //! The "main Direction" of this coordinate system is the
 //! vector normal to the plane of the circle. The axis, of
 //! which the origin and unit vector are respectively the
 //! origin and "main Direction" of the local coordinate
 //! system, is termed the "Axis" or "main Axis" of the circle.
 //! The "main Direction" of the local coordinate system
 //! gives an explicit orientation to the circle (definition of
 //! the trigonometric sense), determining the direction in
 //! which the parameter increases along the circle.
 //! The Geom_Circle circle is parameterized by an angle:
 //! P(U) = O + R*std::cos(U)*XDir + R*Sin(U)*YDir, where:
 //! - P is the point of parameter U,
 //! - O, XDir and YDir are respectively the origin, "X
 //! Direction" and "Y Direction" of its local coordinate system,
 //! - R is the radius of the circle.
 //! The "X Axis" of the local coordinate system therefore
 //! defines the origin of the parameter of the circle. The
 //! parameter is the angle with this "X Direction".
 //! A circle is a closed and periodic curve. The period is
 //! 2.*Pi and the parameter range is [ 0, 2.*Pi [.
 class Geom_Circle : public Geom_Conic
 {
 
 public:
   //! Constructs a circle by conversion of the gp_Circ circle C.
   Standard_EXPORT Geom_Circle(const gp_Circ& C);
 
   //! Constructs a circle of radius Radius, where A2 locates the circle and
   //! defines its orientation in 3D space such that:
   //! - the center of the circle is the origin of A2,
   //! - the origin, "X Direction" and "Y Direction" of A2
   //! define the plane of the circle,
   //! - A2 is the local coordinate system of the circle.
   //! Note: It is possible to create a circle where Radius is equal to 0.0.
   //! raised if Radius < 0.
   Standard_EXPORT Geom_Circle(const gp_Ax2& A2, const double Radius);
 
   //! Set <me> so that <me> has the same geometric properties as C.
   Standard_EXPORT void SetCirc(const gp_Circ& C);
 
   //! Assigns the value R to the radius of this circle.
   //! Note: it is possible to have a circle with a radius equal to 0.0.
   //! Exceptions - Standard_ConstructionError if R is negative.
   Standard_EXPORT void SetRadius(const double R);
 
   //! returns the non transient circle from gp with the same
   //! geometric properties as <me>.
   Standard_EXPORT gp_Circ Circ() const;
 
   //! Returns the radius of this circle.
   Standard_EXPORT double Radius() const;
 
   //! Computes the parameter on the reversed circle for
   //! the point of parameter U on this circle.
   //! For a circle, the returned value is: 2.*Pi - U.
   Standard_EXPORT double ReversedParameter(const double U) const final;
 
   //! Returns the eccentricity e = 0 for a circle.
   Standard_EXPORT double Eccentricity() const final;
 
   //! Returns the value of the first parameter of this
   //! circle. This is 0.0, which gives the start point of this circle, or
   //! The start point and end point of a circle are coincident.
   Standard_EXPORT double FirstParameter() const final;
 
   //! Returns the value of the last parameter of this
   //! circle. This is 2.*Pi, which gives the end point of this circle.
   //! The start point and end point of a circle are coincident.
   Standard_EXPORT double LastParameter() const final;
 
   //! returns True.
   Standard_EXPORT bool IsClosed() const final;
 
   //! returns True.
   Standard_EXPORT bool IsPeriodic() const final;
 
   //! Returns the point of parameter U.
   //! P = C + R * Cos (U) * XDir + R * Sin (U) * YDir
   //! where C is the center of the circle , XDir the XDirection and
   //! YDir the YDirection of the circle's local coordinate system.
   Standard_EXPORT gp_Pnt EvalD0(const double U) const final;
 
   //! Returns the point of parameter U and the first derivative.
   Standard_EXPORT Geom_Curve::ResD1 EvalD1(const double U) const final;
 
   //! Returns the point of parameter U, the first and second
   //! derivatives.
   Standard_EXPORT Geom_Curve::ResD2 EvalD2(const double U) const final;
 
   //! Returns the point of parameter U, the first, second and third
   //! derivatives.
   Standard_EXPORT Geom_Curve::ResD3 EvalD3(const double U) const final;
 
   //! Returns the vector corresponding to the derivative for the
   //! order of derivation N.
   //! Raised if N < 1.
   Standard_EXPORT gp_Vec EvalDN(const double U, const int N) const final;
 
   //! Applies the transformation T to this circle.
   Standard_EXPORT void Transform(const gp_Trsf& T) final;
 
   //! Creates a new object which is a copy of this circle.
   Standard_EXPORT occ::handle<Geom_Geometry> Copy() const final;
 
   //! Dumps the content of me into the stream
   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const final;
 
   DEFINE_STANDARD_RTTIEXT(Geom_Circle, Geom_Conic)
 
 private:
   double radius;
 };
 
 #endif // _Geom_Circle_HeaderFile

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