// Copyright (c) 1991-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 _gp_Circ2d_HeaderFile #define _gp_Circ2d_HeaderFile #include #include #include #include #include #include #include class Standard_ConstructionError; class gp_Ax2d; class gp_Ax22d; class gp_Pnt2d; class gp_Trsf2d; class gp_Vec2d; //! Describes a circle in the plane (2D space). //! A circle is defined by its radius and positioned in the //! plane with a coordinate system (a gp_Ax22d object) as follows: //! - the origin of the coordinate system is the center of the circle, and //! - the orientation (direct or indirect) of the coordinate //! system gives an implicit orientation to the circle (and //! defines its trigonometric sense). //! This positioning coordinate system is the "local //! coordinate system" of the circle. //! Note: when a gp_Circ2d circle is converted into a //! Geom2d_Circle circle, some implicit properties of the //! circle are used explicitly: //! - the implicit orientation corresponds to the direction in //! which parameter values increase, //! - the starting point for parameterization is that of the "X //! Axis" of the local coordinate system (i.e. the "X Axis" of the circle). //! See Also //! GccAna and Geom2dGcc packages which provide //! functions for constructing circles defined by geometric constraints //! gce_MakeCirc2d which provides functions for more //! complex circle constructions //! Geom2d_Circle which provides additional functions for //! constructing circles and works, with the parametric //! equations of circles in particular gp_Ax22d class gp_Circ2d { public: DEFINE_STANDARD_ALLOC //! creates an indefinite circle. gp_Circ2d(); //! The location point of XAxis is the center of the circle. //! Warnings : //! It is not forbidden to create a circle with Radius = 0.0 Raises ConstructionError if Radius < 0.0. //! Raised if Radius < 0.0. gp_Circ2d(const gp_Ax2d& XAxis, const Standard_Real Radius, const Standard_Boolean Sense = Standard_True); //! Axis defines the Xaxis and Yaxis of the circle which defines //! the origin and the sense of parametrization. //! The location point of Axis is the center of the circle. //! Warnings : //! It is not forbidden to create a circle with Radius = 0.0 Raises ConstructionError if Radius < 0.0. //! Raised if Radius < 0.0. gp_Circ2d(const gp_Ax22d& Axis, const Standard_Real Radius); //! Changes the location point (center) of the circle. void SetLocation (const gp_Pnt2d& P); //! Changes the X axis of the circle. void SetXAxis (const gp_Ax2d& A); //! Changes the X axis of the circle. void SetAxis (const gp_Ax22d& A); //! Changes the Y axis of the circle. void SetYAxis (const gp_Ax2d& A); //! Modifies the radius of this circle. //! This class does not prevent the creation of a circle where //! Radius is null. //! Exceptions //! Standard_ConstructionError if Radius is negative. void SetRadius (const Standard_Real Radius); //! Computes the area of the circle. Standard_Real Area() const; //! Returns the normalized coefficients from the implicit equation //! of the circle : //! A * (X**2) + B * (Y**2) + 2*C*(X*Y) + 2*D*X + 2*E*Y + F = 0.0 void Coefficients (Standard_Real& A, Standard_Real& B, Standard_Real& C, Standard_Real& D, Standard_Real& E, Standard_Real& F) const; //! Does contain P ? //! Returns True if the distance between P and any point on //! the circumference of the circle is lower of equal to //! . Standard_Boolean Contains (const gp_Pnt2d& P, const Standard_Real LinearTolerance) const; //! Computes the minimum of distance between the point P and any //! point on the circumference of the circle. Standard_Real Distance (const gp_Pnt2d& P) const; //! Computes the square distance between and the point P. Standard_Real SquareDistance (const gp_Pnt2d& P) const; //! computes the circumference of the circle. Standard_Real Length() const; //! Returns the location point (center) of the circle. const gp_Pnt2d& Location() const; //! Returns the radius value of the circle. Standard_Real Radius() const; //! returns the position of the circle. const gp_Ax22d& Axis() const; //! returns the position of the circle. Idem Axis(me). const gp_Ax22d& Position() const; //! returns the X axis of the circle. gp_Ax2d XAxis() const; //! Returns the Y axis of the circle. //! Reverses the direction of the circle. gp_Ax2d YAxis() const; //! Reverses the orientation of the local coordinate system //! of this circle (the "Y Direction" is reversed) and therefore //! changes the implicit orientation of this circle. //! Reverse assigns the result to this circle, void Reverse(); //! Reverses the orientation of the local coordinate system //! of this circle (the "Y Direction" is reversed) and therefore //! changes the implicit orientation of this circle. //! Reversed creates a new circle. Standard_NODISCARD gp_Circ2d Reversed() const; //! Returns true if the local coordinate system is direct //! and false in the other case. Standard_Boolean IsDirect() const; Standard_EXPORT void Mirror (const gp_Pnt2d& P); //! Performs the symmetrical transformation of a circle with respect //! to the point P which is the center of the symmetry Standard_NODISCARD Standard_EXPORT gp_Circ2d Mirrored (const gp_Pnt2d& P) const; Standard_EXPORT void Mirror (const gp_Ax2d& A); //! Performs the symmetrical transformation of a circle with respect //! to an axis placement which is the axis of the symmetry. Standard_NODISCARD Standard_EXPORT gp_Circ2d Mirrored (const gp_Ax2d& A) const; void Rotate (const gp_Pnt2d& P, const Standard_Real Ang); //! Rotates a circle. P is the center of the rotation. //! Ang is the angular value of the rotation in radians. Standard_NODISCARD gp_Circ2d Rotated (const gp_Pnt2d& P, const Standard_Real Ang) const; void Scale (const gp_Pnt2d& P, const Standard_Real S); //! Scales a circle. S is the scaling value. //! Warnings : //! If S is negative the radius stay positive but //! the "XAxis" and the "YAxis" are reversed as for //! an ellipse. Standard_NODISCARD gp_Circ2d Scaled (const gp_Pnt2d& P, const Standard_Real S) const; void Transform (const gp_Trsf2d& T); //! Transforms a circle with the transformation T from class Trsf2d. Standard_NODISCARD gp_Circ2d Transformed (const gp_Trsf2d& T) const; void Translate (const gp_Vec2d& V); //! Translates a circle in the direction of the vector V. //! The magnitude of the translation is the vector's magnitude. Standard_NODISCARD gp_Circ2d Translated (const gp_Vec2d& V) const; void Translate (const gp_Pnt2d& P1, const gp_Pnt2d& P2); //! Translates a circle from the point P1 to the point P2. Standard_NODISCARD gp_Circ2d Translated (const gp_Pnt2d& P1, const gp_Pnt2d& P2) const; protected: private: gp_Ax22d pos; Standard_Real radius; }; #include #endif // _gp_Circ2d_HeaderFile