OCC Main Page | FoundationClasses | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

FoundationClasses
TKMath
gp


gp_Circ Class Reference

Describes a circle in 3D space.
A circle is defined by its radius and positioned in space
with a coordinate system (a gp_Ax2 object) as follows:
- the origin of the coordinate system is the center of the circle, and
- the origin, "X Direction" and "Y Direction" of the
coordinate system define the plane of the circle.
This positioning coordinate system is the "local <br> coordinate system" of the circle. Its "main Direction"
gives the normal vector to the plane of the circle. The
"main Axis" of the coordinate system is referred to as
the "Axis" of the circle.
Note: when a gp_Circ circle is converted into a
Geom_Circle circle, some implicit properties of the
circle are used explicitly:
- the "main Direction" of the local coordinate system
gives an implicit orientation to the circle (and defines
its trigonometric sense),
- this 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
gce_MakeCirc which provides functions for more complex circle constructions
Geom_Circle which provides additional functions for
constructing circles and works, in particular, with the
parametric equations of circles
.

#include <gp_Circ.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
 gp_Circ ()
 Creates an indefinite circle.
.
 gp_Circ (const gp_Ax2 &A2, const Standard_Real Radius)
 A2 locates the circle and gives its orientation in 3D space.
Warnings :
It is not forbidden to create a circle with Radius = 0.0 Raises ConstructionError if Radius < 0.0
.
void SetAxis (const gp_Ax1 &A1)
 Changes the main axis of the circle. It is the axis
perpendicular to the plane of the circle.
Raises ConstructionError if the direction of A1
is parallel to the "XAxis" of the circle.
.
void SetLocation (const gp_Pnt &P)
 Changes the "Location" point (center) of the circle.
.
void SetPosition (const gp_Ax2 &A2)
 Changes the position of the circle.
.
void SetRadius (const Standard_Real Radius)
 Modifies the radius of this circle.
Warning. This class does not prevent the creation of a circle where Radius is null.
Exceptions
Standard_ConstructionError if Radius is negative.
.
Standard_Real Area () const
 Computes the area of the circle.
.
const gp_Ax1Axis () const
 Returns the main axis of the circle.
It is the axis perpendicular to the plane of the circle,
passing through the "Location" point (center) of the circle.
.
Standard_Real Length () const
 Computes the circumference of the circle.
.
const gp_PntLocation () const
 Returns the center of the circle. It is the
"Location" point of the local coordinate system
of the circle
.
const gp_Ax2Position () const
 Returns the position of the circle.
It is the local coordinate system of the circle.
.
Standard_Real Radius () const
 Returns the radius of this circle.
.
gp_Ax1 XAxis () const
 Returns the "XAxis" of the circle.
This axis is perpendicular to the axis of the conic.
This axis and the "Yaxis" define the plane of the conic.
.
gp_Ax1 YAxis () const
 Returns the "YAxis" of the circle.
This axis and the "Xaxis" define the plane of the conic.
The "YAxis" is perpendicular to the "Xaxis".
.
Standard_Real Distance (const gp_Pnt &P) const
 Computes the minimum of distance between the point P and
any point on the circumference of the circle.
.
Standard_Real SquareDistance (const gp_Pnt &P) const
 Computes the square distance between <me> and the point P.
.
Standard_Boolean Contains (const gp_Pnt &P, const Standard_Real LinearTolerance) const
 Returns True if the point P is on the circumference.
The distance between <me> and

must be lower or
equal to LinearTolerance.
.

Standard_EXPORT void Mirror (const gp_Pnt &P)
Standard_EXPORT gp_Circ Mirrored (const gp_Pnt &P) const
 Performs the symmetrical transformation of a circle
with respect to the point P which is the center of the
symmetry.
.
Standard_EXPORT void Mirror (const gp_Ax1 &A1)
Standard_EXPORT gp_Circ Mirrored (const gp_Ax1 &A1) const
 Performs the symmetrical transformation of a circle with
respect to an axis placement which is the axis of the
symmetry.
.
Standard_EXPORT void Mirror (const gp_Ax2 &A2)
Standard_EXPORT gp_Circ Mirrored (const gp_Ax2 &A2) const
 Performs the symmetrical transformation of a circle with respect
to a plane. The axis placement A2 locates the plane of the
of the symmetry : (Location, XDirection, YDirection).
.
void Rotate (const gp_Ax1 &A1, const Standard_Real Ang)
gp_Circ Rotated (const gp_Ax1 &A1, const Standard_Real Ang) const
 Rotates a circle. A1 is the axis of the rotation.
Ang is the angular value of the rotation in radians.
.
void Scale (const gp_Pnt &P, const Standard_Real S)
gp_Circ Scaled (const gp_Pnt &P, const Standard_Real S) const
 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.
.
void Transform (const gp_Trsf &T)
gp_Circ Transformed (const gp_Trsf &T) const
 Transforms a circle with the transformation T from class Trsf.
.
void Translate (const gp_Vec &V)
gp_Circ Translated (const gp_Vec &V) const
 Translates a circle in the direction of the vector V.
The magnitude of the translation is the vector's magnitude.
.
void Translate (const gp_Pnt &P1, const gp_Pnt &P2)
gp_Circ Translated (const gp_Pnt &P1, const gp_Pnt &P2) const
 Translates a circle from the point P1 to the point P2.
.
const gp_Ax2_CSFDB_Getgp_Circpos () const
Standard_Real _CSFDB_Getgp_Circradius () const
void _CSFDB_Setgp_Circradius (const Standard_Real p)

Private Attributes

gp_Ax2 pos
Standard_Real radius

Friends

Standard_EXPORT friend Handle_Standard_Type & gp_Circ_Type_ ()


Constructor & Destructor Documentation

gp_Circ::gp_Circ  )  [inline]
 

gp_Circ::gp_Circ const gp_Ax2 A2,
const Standard_Real  Radius
[inline]
 


Member Function Documentation

const gp_Ax2& gp_Circ::_CSFDB_Getgp_Circpos  )  const [inline]
 

Standard_Real gp_Circ::_CSFDB_Getgp_Circradius  )  const [inline]
 

void gp_Circ::_CSFDB_Setgp_Circradius const Standard_Real  p  )  [inline]
 

Standard_Real gp_Circ::Area  )  const [inline]
 

const gp_Ax1 & gp_Circ::Axis  )  const [inline]
 

Standard_Boolean gp_Circ::Contains const gp_Pnt P,
const Standard_Real  LinearTolerance
const [inline]
 

Standard_Real gp_Circ::Distance const gp_Pnt P  )  const [inline]
 

Standard_Real gp_Circ::Length  )  const [inline]
 

const gp_Pnt & gp_Circ::Location  )  const [inline]
 

Standard_EXPORT void gp_Circ::Mirror const gp_Ax2 A2  ) 
 

Standard_EXPORT void gp_Circ::Mirror const gp_Ax1 A1  ) 
 

Standard_EXPORT void gp_Circ::Mirror const gp_Pnt P  ) 
 

Standard_EXPORT gp_Circ gp_Circ::Mirrored const gp_Ax2 A2  )  const
 

Standard_EXPORT gp_Circ gp_Circ::Mirrored const gp_Ax1 A1  )  const
 

Standard_EXPORT gp_Circ gp_Circ::Mirrored const gp_Pnt P  )  const
 

void gp_Circ::operator delete void *  anAddress  )  [inline]
 

void* gp_Circ::operator new size_t  size  )  [inline]
 

void* gp_Circ::operator new size_t  ,
void *  anAddress
[inline]
 

const gp_Ax2 & gp_Circ::Position  )  const [inline]
 

Standard_Real gp_Circ::Radius  )  const [inline]
 

void gp_Circ::Rotate const gp_Ax1 A1,
const Standard_Real  Ang
[inline]
 

gp_Circ gp_Circ::Rotated const gp_Ax1 A1,
const Standard_Real  Ang
const [inline]
 

void gp_Circ::Scale const gp_Pnt P,
const Standard_Real  S
[inline]
 

gp_Circ gp_Circ::Scaled const gp_Pnt P,
const Standard_Real  S
const [inline]
 

void gp_Circ::SetAxis const gp_Ax1 A1  )  [inline]
 

void gp_Circ::SetLocation const gp_Pnt P  )  [inline]
 

void gp_Circ::SetPosition const gp_Ax2 A2  )  [inline]
 

void gp_Circ::SetRadius const Standard_Real  Radius  )  [inline]
 

Standard_Real gp_Circ::SquareDistance const gp_Pnt P  )  const [inline]
 

void gp_Circ::Transform const gp_Trsf T  )  [inline]
 

gp_Circ gp_Circ::Transformed const gp_Trsf T  )  const [inline]
 

void gp_Circ::Translate const gp_Pnt P1,
const gp_Pnt P2
[inline]
 

void gp_Circ::Translate const gp_Vec V  )  [inline]
 

gp_Circ gp_Circ::Translated const gp_Pnt P1,
const gp_Pnt P2
const [inline]
 

gp_Circ gp_Circ::Translated const gp_Vec V  )  const [inline]
 

gp_Ax1 gp_Circ::XAxis  )  const [inline]
 

gp_Ax1 gp_Circ::YAxis  )  const [inline]
 


Friends And Related Function Documentation

Standard_EXPORT friend Handle_Standard_Type& gp_Circ_Type_  )  [friend]
 


Field Documentation

gp_Ax2 gp_Circ::pos [private]
 

Standard_Real gp_Circ::radius [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:12:40 2008 for OpenCASCADE by  doxygen 1.4.1