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
constexpr	gp_Circ () noexcept
	Creates an indefinite circle.
constexpr	gp_Circ (const gp_Ax2 &theA2, const double 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.
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.
constexpr void	SetLocation (const gp_Pnt &theP) noexcept
	Changes the "Location" point (center) of the circle.
constexpr void	SetPosition (const gp_Ax2 &theA2) noexcept
	Changes the position of the circle.
void	SetRadius (const double theRadius)
	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.
constexpr double	Area () const noexcept
	Computes the area of the circle.
constexpr const gp_Ax1 &	Axis () const noexcept
	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.
constexpr double	Length () const noexcept
	Computes the circumference of the circle.
constexpr const gp_Pnt &	Location () const noexcept
	Returns the center of the circle. It is the "Location" point of the local coordinate system of the circle.
constexpr const gp_Ax2 &	Position () const noexcept
	Returns the position of the circle. It is the local coordinate system of the circle.
constexpr double	Radius () const noexcept
	Returns the radius of this circle.
constexpr gp_Ax1	XAxis () const noexcept
	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.
constexpr gp_Ax1	YAxis () const noexcept
	Returns the "YAxis" of the circle. This axis and the "Xaxis" define the plane of the conic. The "YAxis" is perpendicular to the "Xaxis".
double	Distance (const gp_Pnt &theP) const noexcept
	Computes the minimum of distance between the point theP and any point on the circumference of the circle.
double	SquareDistance (const gp_Pnt &theP) const noexcept
	Computes the square distance between <me> and the point theP.
bool	Contains (const gp_Pnt &theP, const double theLinearTolerance) const noexcept
	Returns True if the point theP is on the circumference. The distance between <me> and <theP> must be lower or equal to theLinearTolerance.
void	Mirror (const gp_Pnt &theP) noexcept
gp_Circ	Mirrored (const gp_Pnt &theP) const noexcept
	Performs the symmetrical transformation of a circle with respect to the point theP which is the center of the symmetry.
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.
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).
void	Rotate (const gp_Ax1 &theA1, const double theAng)
gp_Circ	Rotated (const gp_Ax1 &theA1, const double theAng) const
	Rotates a circle. theA1 is the axis of the rotation. theAng is the angular value of the rotation in radians.
void	Scale (const gp_Pnt &theP, const double theS)
gp_Circ	Scaled (const gp_Pnt &theP, const double 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.
void	Transform (const gp_Trsf &theT)
gp_Circ	Transformed (const gp_Trsf &theT) const
	Transforms a circle with the transformation theT from class Trsf.
constexpr void	Translate (const gp_Vec &theV) noexcept
constexpr gp_Circ	Translated (const gp_Vec &theV) const noexcept
	Translates a circle in the direction of the vector theV. The magnitude of the translation is the vector's magnitude.
constexpr void	Translate (const gp_Pnt &theP1, const gp_Pnt &theP2) noexcept
constexpr gp_Circ	Translated (const gp_Pnt &theP1, const gp_Pnt &theP2) const noexcept
	Translates a circle from the point theP1 to the point theP2.

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

Constructor & Destructor Documentation

gp_Circ() [1/2]

gp_Circ::gp_Circ ( )

inlineconstexprnoexcept

Creates an indefinite circle.

gp_Circ() [2/2]

gp_Circ::gp_Circ ( const gp_Ax2 & theA2, const double theRadius )

inlineconstexpr

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.

Member Function Documentation

Area()

double gp_Circ::Area ( ) const

inlineconstexprnoexcept

Computes the area of the circle.

Axis()

const gp_Ax1 & gp_Circ::Axis ( ) const

inlineconstexprnoexcept

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

bool gp_Circ::Contains ( const gp_Pnt & theP, const double theLinearTolerance ) const

inlinenoexcept

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

Distance()

double gp_Circ::Distance ( const gp_Pnt & theP ) const

inlinenoexcept

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

Length()

double gp_Circ::Length ( ) const

inlineconstexprnoexcept

Computes the circumference of the circle.

Location()

const gp_Pnt & gp_Circ::Location ( ) const

inlineconstexprnoexcept

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 )

noexcept

Mirrored() [1/3]

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

nodiscard

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

nodiscard

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

nodiscardnoexcept

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

inlineconstexprnoexcept

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

Radius()

double gp_Circ::Radius ( ) const

inlineconstexprnoexcept

Returns the radius of this circle.

Rotate()

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

inline

Rotated()

gp_Circ gp_Circ::Rotated ( const gp_Ax1 & theA1, const double theAng ) const

inlinenodiscard

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 double theS )

inline

Scaled()

gp_Circ gp_Circ::Scaled ( const gp_Pnt & theP, const double theS ) const

inlinenodiscard

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 )

inlineconstexprnoexcept

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

SetPosition()

void gp_Circ::SetPosition ( const gp_Ax2 & theA2 )

inlineconstexprnoexcept

Changes the position of the circle.

SetRadius()

void gp_Circ::SetRadius ( const double 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()

double gp_Circ::SquareDistance ( const gp_Pnt & theP ) const

inlinenoexcept

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

inlinenodiscard

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 )

inlineconstexprnoexcept

Translate() [2/2]

void gp_Circ::Translate ( const gp_Vec & theV )

inlineconstexprnoexcept

Translated() [1/2]

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

inlinenodiscardconstexprnoexcept

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

Translated() [2/2]

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

inlinenodiscardconstexprnoexcept

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

inlineconstexprnoexcept

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

inlineconstexprnoexcept

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:

• gp_Circ.hxx