Open CASCADE Technology  7.7.0.dev

# 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: More...

`#include <gp_Circ.hxx>`

## Public Member Functions

gp_Circ ()
Creates an indefinite circle. More...

gp_Circ (const gp_Ax2 &theA2, const Standard_Real theRadius)
A2 locates the circle and gives its orientation in 3D space. Warnings : It is not forbidden to create a circle with theRadius = 0.0 Raises ConstructionError if theRadius < 0.0. More...

void SetAxis (const gp_Ax1 &theA1)
Changes the main axis of the circle. It is the axis perpendicular to the plane of the circle. Raises ConstructionError if the direction of theA1 is parallel to the "XAxis" of the circle. More...

void SetLocation (const gp_Pnt &theP)
Changes the "Location" point (center) of the circle. More...

void SetPosition (const gp_Ax2 &theA2)
Changes the position of the circle. More...

Modifies the radius of this circle. Warning. This class does not prevent the creation of a circle where theRadius is null. Exceptions Standard_ConstructionError if theRadius is negative. More...

Standard_Real Area () const
Computes the area of the circle. More...

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. More...

Standard_Real Length () const
Computes the circumference of the circle. More...

const gp_PntLocation () const
Returns the center of the circle. It is the "Location" point of the local coordinate system of the circle. More...

const gp_Ax2Position () const
Returns the position of the circle. It is the local coordinate system of the circle. More...

Standard_Real Radius () const
Returns the radius of this circle. More...

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. More...

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". More...

Standard_Real Distance (const gp_Pnt &theP) const
Computes the minimum of distance between the point theP and any point on the circumference of the circle. More...

Standard_Real SquareDistance (const gp_Pnt &theP) const
Computes the square distance between <me> and the point theP. More...

Standard_Boolean Contains (const gp_Pnt &theP, const Standard_Real theLinearTolerance) const
Returns True if the point theP is on the circumference. The distance between <me> and <theP> must be lower or equal to theLinearTolerance. More...

void Mirror (const gp_Pnt &theP)

gp_Circ Mirrored (const gp_Pnt &theP) const
Performs the symmetrical transformation of a circle with respect to the point theP which is the center of the symmetry. More...

void Mirror (const gp_Ax1 &theA1)

gp_Circ Mirrored (const gp_Ax1 &theA1) const
Performs the symmetrical transformation of a circle with respect to an axis placement which is the axis of the symmetry. More...

void Mirror (const gp_Ax2 &theA2)

gp_Circ Mirrored (const gp_Ax2 &theA2) const
Performs the symmetrical transformation of a circle with respect to a plane. The axis placement theA2 locates the plane of the of the symmetry : (Location, XDirection, YDirection). More...

void Rotate (const gp_Ax1 &theA1, const Standard_Real theAng)

gp_Circ Rotated (const gp_Ax1 &theA1, const Standard_Real theAng) const
Rotates a circle. theA1 is the axis of the rotation. theAng is the angular value of the rotation in radians. More...

void Scale (const gp_Pnt &theP, const Standard_Real theS)

gp_Circ Scaled (const gp_Pnt &theP, const Standard_Real theS) const
Scales a circle. theS is the scaling value. Warnings : If theS is negative the radius stay positive but the "XAxis" and the "YAxis" are reversed as for an ellipse. More...

void Transform (const gp_Trsf &theT)

gp_Circ Transformed (const gp_Trsf &theT) const
Transforms a circle with the transformation theT from class Trsf. More...

void Translate (const gp_Vec &theV)

gp_Circ Translated (const gp_Vec &theV) const
Translates a circle in the direction of the vector theV. The magnitude of the translation is the vector's magnitude. More...

void Translate (const gp_Pnt &theP1, const gp_Pnt &theP2)

gp_Circ Translated (const gp_Pnt &theP1, const gp_Pnt &theP2) const
Translates a circle from the point theP1 to the point theP2. More...

## Detailed Description

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 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

## ◆ gp_Circ() [1/2]

 gp_Circ::gp_Circ ( )
inline

Creates an indefinite circle.

## ◆ gp_Circ() [2/2]

 gp_Circ::gp_Circ ( const gp_Ax2 & theA2, const Standard_Real theRadius )
inline

A2 locates the circle and gives its orientation in 3D space. Warnings : It is not forbidden to create a circle with theRadius = 0.0 Raises ConstructionError if theRadius < 0.0.

## ◆ Area()

 Standard_Real gp_Circ::Area ( ) const
inline

Computes the area of the circle.

## ◆ Axis()

 const gp_Ax1& gp_Circ::Axis ( ) const
inline

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.

## ◆ Contains()

 Standard_Boolean gp_Circ::Contains ( const gp_Pnt & theP, const Standard_Real theLinearTolerance ) const
inline

Returns True if the point theP is on the circumference. The distance between <me> and <theP> must be lower or equal to theLinearTolerance.

## ◆ Distance()

 Standard_Real gp_Circ::Distance ( const gp_Pnt & theP ) const
inline

Computes the minimum of distance between the point theP and any point on the circumference of the circle.

## ◆ Length()

 Standard_Real gp_Circ::Length ( void ) const
inline

Computes the circumference of the circle.

## ◆ Location()

 const gp_Pnt& gp_Circ::Location ( ) const
inline

Returns the center of the circle. It is the "Location" point of the local coordinate system of the circle.

## ◆ Mirror() [1/3]

 void gp_Circ::Mirror ( const gp_Ax1 & theA1 )

## ◆ Mirror() [2/3]

 void gp_Circ::Mirror ( const gp_Ax2 & theA2 )

## ◆ Mirror() [3/3]

 void gp_Circ::Mirror ( const gp_Pnt & theP )

## ◆ Mirrored() [1/3]

 gp_Circ gp_Circ::Mirrored ( const gp_Ax1 & theA1 ) const

Performs the symmetrical transformation of a circle with respect to an axis placement which is the axis of the symmetry.

## ◆ Mirrored() [2/3]

 gp_Circ gp_Circ::Mirrored ( const gp_Ax2 & theA2 ) const

Performs the symmetrical transformation of a circle with respect to a plane. The axis placement theA2 locates the plane of the of the symmetry : (Location, XDirection, YDirection).

## ◆ Mirrored() [3/3]

 gp_Circ gp_Circ::Mirrored ( const gp_Pnt & theP ) const

Performs the symmetrical transformation of a circle with respect to the point theP which is the center of the symmetry.

## ◆ Position()

 const gp_Ax2& gp_Circ::Position ( ) const
inline

Returns the position of the circle. It is the local coordinate system of the circle.

 Standard_Real gp_Circ::Radius ( ) const
inline

Returns the radius of this circle.

## ◆ Rotate()

 void gp_Circ::Rotate ( const gp_Ax1 & theA1, const Standard_Real theAng )
inline

## ◆ Rotated()

 gp_Circ gp_Circ::Rotated ( const gp_Ax1 & theA1, const Standard_Real theAng ) const
inline

Rotates a circle. theA1 is the axis of the rotation. theAng is the angular value of the rotation in radians.

## ◆ Scale()

 void gp_Circ::Scale ( const gp_Pnt & theP, const Standard_Real theS )
inline

## ◆ Scaled()

 gp_Circ gp_Circ::Scaled ( const gp_Pnt & theP, const Standard_Real theS ) const
inline

Scales a circle. theS is the scaling value. Warnings : If theS is negative the radius stay positive but the "XAxis" and the "YAxis" are reversed as for an ellipse.

## ◆ SetAxis()

 void gp_Circ::SetAxis ( const gp_Ax1 & theA1 )
inline

Changes the main axis of the circle. It is the axis perpendicular to the plane of the circle. Raises ConstructionError if the direction of theA1 is parallel to the "XAxis" of the circle.

## ◆ SetLocation()

 void gp_Circ::SetLocation ( const gp_Pnt & theP )
inline

Changes the "Location" point (center) of the circle.

## ◆ SetPosition()

 void gp_Circ::SetPosition ( const gp_Ax2 & theA2 )
inline

Changes the position of the circle.

 void gp_Circ::SetRadius ( const Standard_Real theRadius )
inline

Modifies the radius of this circle. Warning. This class does not prevent the creation of a circle where theRadius is null. Exceptions Standard_ConstructionError if theRadius is negative.

## ◆ SquareDistance()

 Standard_Real gp_Circ::SquareDistance ( const gp_Pnt & theP ) const
inline

Computes the square distance between <me> and the point theP.

## ◆ Transform()

 void gp_Circ::Transform ( const gp_Trsf & theT )
inline

## ◆ Transformed()

 gp_Circ gp_Circ::Transformed ( const gp_Trsf & theT ) const
inline

Transforms a circle with the transformation theT from class Trsf.

## ◆ Translate() [1/2]

 void gp_Circ::Translate ( const gp_Pnt & theP1, const gp_Pnt & theP2 )
inline

## ◆ Translate() [2/2]

 void gp_Circ::Translate ( const gp_Vec & theV )
inline

## ◆ Translated() [1/2]

 gp_Circ gp_Circ::Translated ( const gp_Pnt & theP1, const gp_Pnt & theP2 ) const
inline

Translates a circle from the point theP1 to the point theP2.

## ◆ Translated() [2/2]

 gp_Circ gp_Circ::Translated ( const gp_Vec & theV ) const
inline

Translates a circle in the direction of the vector theV. The magnitude of the translation is the vector's magnitude.

## ◆ XAxis()

 gp_Ax1 gp_Circ::XAxis ( ) const
inline

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.

## ◆ YAxis()

 gp_Ax1 gp_Circ::YAxis ( ) const
inline

Returns the "YAxis" of the circle. This axis and the "Xaxis" define the plane of the conic. The "YAxis" is perpendicular to the "Xaxis".

The documentation for this class was generated from the following file: