Describes a sphere. A sphere is defined by its radius and positioned in space with a coordinate system (a gp_Ax3 object). The origin of the coordinate system is the center of the sphere. This coordinate system is the "local coordinate system" of the sphere. Note: when a gp_Sphere sphere is converted into a Geom_SphericalSurface sphere, some implicit properties of its local coordinate system are used explicitly: More...

#include <gp_Sphere.hxx>

Public Member Functions
constexpr	gp_Sphere () noexcept
	Creates an indefinite sphere.
constexpr	gp_Sphere (const gp_Ax3 &theA3, const double theRadius)
	Constructs a sphere with radius theRadius, centered on the origin of theA3. theA3 is the local coordinate system of the sphere. Warnings: It is not forbidden to create a sphere with null radius. Raises ConstructionError if theRadius < 0.0.
constexpr void	SetLocation (const gp_Pnt &theLoc) noexcept
	Changes the center of the sphere.
constexpr void	SetPosition (const gp_Ax3 &theA3) noexcept
	Changes the local coordinate system of the sphere.
void	SetRadius (const double theR)
	Assigns theR the radius of the Sphere. Warnings : It is not forbidden to create a sphere with null radius. Raises ConstructionError if theR < 0.0.
constexpr double	Area () const noexcept
	Computes the area of the sphere.
void	Coefficients (double &theA1, double &theA2, double &theA3, double &theB1, double &theB2, double &theB3, double &theC1, double &theC2, double &theC3, double &theD) const
	Computes the coefficients of the implicit equation of the quadric in the absolute cartesian coordinates system :
constexpr void	UReverse () noexcept
	Reverses the U parametrization of the sphere reversing the YAxis.
constexpr void	VReverse () noexcept
	Reverses the V parametrization of the sphere reversing the ZAxis.
bool	Direct () const
	Returns true if the local coordinate system of this sphere is right-handed.
constexpr const gp_Pnt &	Location () const noexcept
	— Purpose ; Returns the center of the sphere.
constexpr const gp_Ax3 &	Position () const noexcept
	Returns the local coordinates system of the sphere.
constexpr double	Radius () const noexcept
	Returns the radius of the sphere.
constexpr double	Volume () const noexcept
	Computes the volume of the sphere.
constexpr gp_Ax1	XAxis () const noexcept
	Returns the axis X of the sphere.
constexpr gp_Ax1	YAxis () const noexcept
	Returns the axis Y of the sphere.
void	Mirror (const gp_Pnt &theP) noexcept
gp_Sphere	Mirrored (const gp_Pnt &theP) const noexcept
	Performs the symmetrical transformation of a sphere with respect to the point theP which is the center of the symmetry.
void	Mirror (const gp_Ax1 &theA1) noexcept
gp_Sphere	Mirrored (const gp_Ax1 &theA1) const noexcept
	Performs the symmetrical transformation of a sphere with respect to an axis placement which is the axis of the symmetry.
void	Mirror (const gp_Ax2 &theA2) noexcept
gp_Sphere	Mirrored (const gp_Ax2 &theA2) const noexcept
	Performs the symmetrical transformation of a sphere 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_Sphere	Rotated (const gp_Ax1 &theA1, const double theAng) const
	Rotates a sphere. 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_Sphere	Scaled (const gp_Pnt &theP, const double theS) const
	Scales a sphere. theS is the scaling value. The absolute value of S is used to scale the sphere.
void	Transform (const gp_Trsf &theT)
gp_Sphere	Transformed (const gp_Trsf &theT) const
	Transforms a sphere with the transformation theT from class Trsf.
constexpr void	Translate (const gp_Vec &theV) noexcept
constexpr gp_Sphere	Translated (const gp_Vec &theV) const noexcept
	Translates a sphere 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_Sphere	Translated (const gp_Pnt &theP1, const gp_Pnt &theP2) const noexcept
	Translates a sphere from the point theP1 to the point theP2.

Detailed Description

Describes a sphere. A sphere is defined by its radius and positioned in space with a coordinate system (a gp_Ax3 object). The origin of the coordinate system is the center of the sphere. This coordinate system is the "local coordinate system" of the sphere. Note: when a gp_Sphere sphere is converted into a Geom_SphericalSurface sphere, some implicit properties of its local coordinate system are used explicitly:

its origin, "X Direction", "Y Direction" and "main Direction" are used directly to define the parametric directions on the sphere and the origin of the parameters,
its implicit orientation (right-handed or left-handed) gives the orientation (direct, indirect) to the Geom_SphericalSurface sphere. See Also gce_MakeSphere which provides functions for more complex sphere constructions Geom_SphericalSurface which provides additional functions for constructing spheres and works, in particular, with the parametric equations of spheres.

Constructor & Destructor Documentation

◆ gp_Sphere() [1/2]

gp_Sphere::gp_Sphere ( )

inlineconstexprnoexcept

Creates an indefinite sphere.

◆ gp_Sphere() [2/2]

gp_Sphere::gp_Sphere	(	const gp_Ax3 &	theA3,
		const double	theRadius )

inlineconstexpr

Constructs a sphere with radius theRadius, centered on the origin of theA3. theA3 is the local coordinate system of the sphere. Warnings: It is not forbidden to create a sphere with null radius. Raises ConstructionError if theRadius < 0.0.

Member Function Documentation

◆ Area()

double gp_Sphere::Area ( ) const

inlineconstexprnoexcept

Computes the area of the sphere.

◆ Coefficients()

void gp_Sphere::Coefficients	(	double &	theA1,
		double &	theA2,
		double &	theA3,
		double &	theB1,
		double &	theB2,
		double &	theB3,
		double &	theC1,
		double &	theC2,
		double &	theC3,
		double &	theD ) const

Computes the coefficients of the implicit equation of the quadric in the absolute cartesian coordinates system :

theA1.X**2 + theA2.Y**2 + theA3.Z**2 + 2.(theB1.X.Y + theB2.X.Z + theB3.Y.Z) +

2.(theC1.X + theC2.Y + theC3.Z) + theD = 0.0

◆ Direct()

bool gp_Sphere::Direct ( ) const

inline

Returns true if the local coordinate system of this sphere is right-handed.

◆ Location()

const gp_Pnt & gp_Sphere::Location ( ) const

inlineconstexprnoexcept

— Purpose ; Returns the center of the sphere.

◆ Mirror() [1/3]

void gp_Sphere::Mirror ( const gp_Ax1 & theA1 )

noexcept

◆ Mirror() [2/3]

void gp_Sphere::Mirror ( const gp_Ax2 & theA2 )

noexcept

◆ Mirror() [3/3]

void gp_Sphere::Mirror ( const gp_Pnt & theP )

noexcept

◆ Mirrored() [1/3]

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

nodiscardnoexcept

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

◆ Mirrored() [2/3]

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

nodiscardnoexcept

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

◆ Mirrored() [3/3]

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

nodiscardnoexcept

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

◆ Position()

const gp_Ax3 & gp_Sphere::Position ( ) const

inlineconstexprnoexcept

Returns the local coordinates system of the sphere.

◆ Radius()

double gp_Sphere::Radius ( ) const

inlineconstexprnoexcept

Returns the radius of the sphere.

◆ Rotate()

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

inline

◆ Rotated()

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

inlinenodiscard

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

◆ Scale()

void gp_Sphere::Scale	(	const gp_Pnt &	theP,
		const double	theS )

inline

◆ Scaled()

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

inlinenodiscard

Scales a sphere. theS is the scaling value. The absolute value of S is used to scale the sphere.

◆ SetLocation()

void gp_Sphere::SetLocation ( const gp_Pnt & theLoc )

inlineconstexprnoexcept

Changes the center of the sphere.

◆ SetPosition()

void gp_Sphere::SetPosition ( const gp_Ax3 & theA3 )

inlineconstexprnoexcept

Changes the local coordinate system of the sphere.

◆ SetRadius()

void gp_Sphere::SetRadius ( const double theR )

inline

Assigns theR the radius of the Sphere. Warnings : It is not forbidden to create a sphere with null radius. Raises ConstructionError if theR < 0.0.

◆ Transform()

void gp_Sphere::Transform ( const gp_Trsf & theT )

inline

◆ Transformed()

gp_Sphere gp_Sphere::Transformed ( const gp_Trsf & theT ) const

inlinenodiscard

Transforms a sphere with the transformation theT from class Trsf.

◆ Translate() [1/2]

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

inlineconstexprnoexcept

◆ Translate() [2/2]

void gp_Sphere::Translate ( const gp_Vec & theV )

inlineconstexprnoexcept

◆ Translated() [1/2]

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

inlinenodiscardconstexprnoexcept

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

◆ Translated() [2/2]

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

inlinenodiscardconstexprnoexcept

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

◆ UReverse()

void gp_Sphere::UReverse ( )

inlineconstexprnoexcept

Reverses the U parametrization of the sphere reversing the YAxis.

◆ Volume()

double gp_Sphere::Volume ( ) const

inlineconstexprnoexcept

Computes the volume of the sphere.

◆ VReverse()

void gp_Sphere::VReverse ( )

inlineconstexprnoexcept

Reverses the V parametrization of the sphere reversing the ZAxis.

◆ XAxis()

gp_Ax1 gp_Sphere::XAxis ( ) const

inlineconstexprnoexcept

Returns the axis X of the sphere.

◆ YAxis()

gp_Ax1 gp_Sphere::YAxis ( ) const

inlineconstexprnoexcept

Returns the axis Y of the sphere.

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

gp_Sphere.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ gp_Sphere() [1/2]

◆ gp_Sphere() [2/2]

Member Function Documentation

◆ Area()

◆ Coefficients()

◆ Direct()

◆ Location()

◆ Mirror() [1/3]

◆ Mirror() [2/3]

◆ Mirror() [3/3]

◆ Mirrored() [1/3]

◆ Mirrored() [2/3]

◆ Mirrored() [3/3]

◆ Position()

◆ Radius()

◆ Rotate()

◆ Rotated()

◆ Scale()

◆ Scaled()

◆ SetLocation()

◆ SetPosition()

◆ SetRadius()

◆ Transform()

◆ Transformed()

◆ Translate() [1/2]

◆ Translate() [2/2]

◆ Translated() [1/2]

◆ Translated() [2/2]

◆ UReverse()

◆ Volume()

◆ VReverse()

◆ XAxis()

◆ YAxis()