Open CASCADE Technology  7.3.1.dev
Public Member Functions
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 &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. More...
 
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. More...
 
void SetLocation (const gp_Pnt &P)
 Changes the "Location" point (center) of the circle. More...
 
void SetPosition (const gp_Ax2 &A2)
 Changes the position of the circle. More...
 
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. 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 &P) const
 Computes the minimum of distance between the point P and any point on the circumference of the circle. More...
 
Standard_Real SquareDistance (const gp_Pnt &P) const
 Computes the square distance between <me> and the point P. More...
 
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. More...
 
void Mirror (const gp_Pnt &P)
 
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. More...
 
void Mirror (const gp_Ax1 &A1)
 
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. More...
 
void Mirror (const gp_Ax2 &A2)
 
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). More...
 
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. More...
 
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. More...
 
void Transform (const gp_Trsf &T)
 
gp_Circ Transformed (const gp_Trsf &T) const
 Transforms a circle with the transformation T from class Trsf. More...
 
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. More...
 
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. 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:

Constructor & Destructor Documentation

◆ gp_Circ() [1/2]

gp_Circ::gp_Circ ( )

Creates an indefinite circle.

◆ gp_Circ() [2/2]

gp_Circ::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.

Member Function Documentation

◆ Area()

Standard_Real gp_Circ::Area ( ) const

Computes the area of the circle.

◆ Axis()

const gp_Ax1& gp_Circ::Axis ( ) 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.

◆ Contains()

Standard_Boolean gp_Circ::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.

◆ Distance()

Standard_Real gp_Circ::Distance ( const gp_Pnt P) const

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

◆ Length()

Standard_Real gp_Circ::Length ( ) const

Computes the circumference of the circle.

◆ Location()

const gp_Pnt& gp_Circ::Location ( ) const

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_Pnt P)

◆ Mirror() [2/3]

void gp_Circ::Mirror ( const gp_Ax1 A1)

◆ Mirror() [3/3]

void gp_Circ::Mirror ( const gp_Ax2 A2)

◆ Mirrored() [1/3]

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

◆ Mirrored() [2/3]

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

◆ Mirrored() [3/3]

gp_Circ 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).

◆ Position()

const gp_Ax2& gp_Circ::Position ( ) const

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

◆ Radius()

Standard_Real gp_Circ::Radius ( ) const

Returns the radius of this circle.

◆ Rotate()

void gp_Circ::Rotate ( const gp_Ax1 A1,
const Standard_Real  Ang 
)

◆ Rotated()

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

◆ Scale()

void gp_Circ::Scale ( const gp_Pnt P,
const Standard_Real  S 
)

◆ Scaled()

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

◆ SetAxis()

void gp_Circ::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.

◆ SetLocation()

void gp_Circ::SetLocation ( const gp_Pnt P)

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

◆ SetPosition()

void gp_Circ::SetPosition ( const gp_Ax2 A2)

Changes the position of the circle.

◆ SetRadius()

void gp_Circ::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.

◆ SquareDistance()

Standard_Real gp_Circ::SquareDistance ( const gp_Pnt P) const

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

◆ Transform()

void gp_Circ::Transform ( const gp_Trsf T)

◆ Transformed()

gp_Circ gp_Circ::Transformed ( const gp_Trsf T) const

Transforms a circle with the transformation T from class Trsf.

◆ Translate() [1/2]

void gp_Circ::Translate ( const gp_Vec V)

◆ Translate() [2/2]

void gp_Circ::Translate ( const gp_Pnt P1,
const gp_Pnt P2 
)

◆ Translated() [1/2]

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

◆ Translated() [2/2]

gp_Circ gp_Circ::Translated ( const gp_Pnt P1,
const gp_Pnt P2 
) const

Translates a circle from the point P1 to the point P2.

◆ XAxis()

gp_Ax1 gp_Circ::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.

◆ YAxis()

gp_Ax1 gp_Circ::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".


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