gp_Sphere Class Reference

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
	gp_Sphere ()
	Creates an indefinite sphere. More...
	gp_Sphere (const gp_Ax3 &A3, const Standard_Real Radius)
	Constructs a sphere with radius Radius, centered on the origin of A3. A3 is the local coordinate system of the sphere. Warnings : It is not forbidden to create a sphere with null radius. Raises ConstructionError if Radius < 0.0. More...
void	SetLocation (const gp_Pnt &Loc)
	Changes the center of the sphere. More...
void	SetPosition (const gp_Ax3 &A3)
	Changes the local coordinate system of the sphere. More...
void	SetRadius (const Standard_Real R)
	Assigns R the radius of the Sphere. Warnings : It is not forbidden to create a sphere with null radius. Raises ConstructionError if R < 0.0. More...
Standard_Real	Area () const
	Computes the aera of the sphere. More...
void	Coefficients (Standard_Real &A1, Standard_Real &A2, Standard_Real &A3, Standard_Real &B1, Standard_Real &B2, Standard_Real &B3, Standard_Real &C1, Standard_Real &C2, Standard_Real &C3, Standard_Real &D) const
	Computes the coefficients of the implicit equation of the quadric in the absolute cartesian coordinates system : A1.X**2 + A2.Y**2 + A3.Z**2 + 2.(B1.X.Y + B2.X.Z + B3.Y.Z) + 2.(C1.X + C2.Y + C3.Z) + D = 0.0. More...
void	UReverse ()
	Reverses the U parametrization of the sphere reversing the YAxis. More...
void	VReverse ()
	Reverses the V parametrization of the sphere reversing the ZAxis. More...
Standard_Boolean	Direct () const
	Returns true if the local coordinate system of this sphere is right-handed. More...
const gp_Pnt &	Location () const
	— Purpose ; Returns the center of the sphere. More...
const gp_Ax3 &	Position () const
	Returns the local coordinates system of the sphere. More...
Standard_Real	Radius () const
	Returns the radius of the sphere. More...
Standard_Real	Volume () const
	Computes the volume of the sphere. More...
gp_Ax1	XAxis () const
	Returns the axis X of the sphere. More...
gp_Ax1	YAxis () const
	Returns the axis Y of the sphere. More...
void	Mirror (const gp_Pnt &P)
gp_Sphere	Mirrored (const gp_Pnt &P) const
	Performs the symmetrical transformation of a sphere with respect to the point P which is the center of the symmetry. More...
void	Mirror (const gp_Ax1 &A1)
gp_Sphere	Mirrored (const gp_Ax1 &A1) const
	Performs the symmetrical transformation of a sphere with respect to an axis placement which is the axis of the symmetry. More...
void	Mirror (const gp_Ax2 &A2)
gp_Sphere	Mirrored (const gp_Ax2 &A2) const
	Performs the symmetrical transformation of a sphere 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_Sphere	Rotated (const gp_Ax1 &A1, const Standard_Real Ang) const
	Rotates a sphere. 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_Sphere	Scaled (const gp_Pnt &P, const Standard_Real S) const
	Scales a sphere. S is the scaling value. The absolute value of S is used to scale the sphere. More...
void	Transform (const gp_Trsf &T)
gp_Sphere	Transformed (const gp_Trsf &T) const
	Transforms a sphere with the transformation T from class Trsf. More...
void	Translate (const gp_Vec &V)
gp_Sphere	Translated (const gp_Vec &V) const
	Translates a sphere 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_Sphere	Translated (const gp_Pnt &P1, const gp_Pnt &P2) const
	Translates a sphere from the point P1 to the point P2. More...
const gp_Ax3 &	_CSFDB_Getgp_Spherepos () const
Standard_Real	_CSFDB_Getgp_Sphereradius () const
void	_CSFDB_Setgp_Sphereradius (const Standard_Real p)

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

(

)

Creates an indefinite sphere.

gp_Sphere::gp_Sphere	(	const gp_Ax3 &	A3,
		const Standard_Real	Radius
	)

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

Member Function Documentation

const gp_Ax3& gp_Sphere::_CSFDB_Getgp_Spherepos ( ) const

inline

Standard_Real gp_Sphere::_CSFDB_Getgp_Sphereradius ( ) const

inline

void gp_Sphere::_CSFDB_Setgp_Sphereradius ( const Standard_Real  p )

inline

Standard_Real gp_Sphere::Area

(

)

const

Computes the aera of the sphere.

void gp_Sphere::Coefficients	(	Standard_Real &	A1,
		Standard_Real &	A2,
		Standard_Real &	A3,
		Standard_Real &	B1,
		Standard_Real &	B2,
		Standard_Real &	B3,
		Standard_Real &	C1,
		Standard_Real &	C2,
		Standard_Real &	C3,
		Standard_Real &	D
	)		const

Computes the coefficients of the implicit equation of the quadric in the absolute cartesian coordinates system : A1.X**2 + A2.Y**2 + A3.Z**2 + 2.(B1.X.Y + B2.X.Z + B3.Y.Z) + 2.(C1.X + C2.Y + C3.Z) + D = 0.0.

Standard_Boolean gp_Sphere::Direct

(

)

const

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

const gp_Pnt& gp_Sphere::Location

(

)

const

— Purpose ; Returns the center of the sphere.

void gp_Sphere::Mirror

(

const gp_Pnt &

P

)

void gp_Sphere::Mirror

(

const gp_Ax1 &

A1

)

void gp_Sphere::Mirror

(

const gp_Ax2 &

A2

)

gp_Sphere gp_Sphere::Mirrored

(

const gp_Pnt &

P

)

const

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

gp_Sphere gp_Sphere::Mirrored

(

const gp_Ax1 &

A1

)

const

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

gp_Sphere gp_Sphere::Mirrored

(

const gp_Ax2 &

A2

)

const

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

const gp_Ax3& gp_Sphere::Position

(

)

const

Returns the local coordinates system of the sphere.

Standard_Real gp_Sphere::Radius

(

)

const

Returns the radius of the sphere.

void gp_Sphere::Rotate	(	const gp_Ax1 &	A1,
		const Standard_Real	Ang
	)

gp_Sphere gp_Sphere::Rotated	(	const gp_Ax1 &	A1,
		const Standard_Real	Ang
	)		const

Rotates a sphere. A1 is the axis of the rotation. Ang is the angular value of the rotation in radians.

void gp_Sphere::Scale	(	const gp_Pnt &	P,
		const Standard_Real	S
	)

gp_Sphere gp_Sphere::Scaled	(	const gp_Pnt &	P,
		const Standard_Real	S
	)		const

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

void gp_Sphere::SetLocation

(

const gp_Pnt &

Loc

)

Changes the center of the sphere.

void gp_Sphere::SetPosition

(

const gp_Ax3 &

A3

)

Changes the local coordinate system of the sphere.

void gp_Sphere::SetRadius

(

const Standard_Real

R

)

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

void gp_Sphere::Transform

(

const gp_Trsf &

T

)

gp_Sphere gp_Sphere::Transformed

(

const gp_Trsf &

T

)

const

Transforms a sphere with the transformation T from class Trsf.

void gp_Sphere::Translate

(

const gp_Vec &

V

)

void gp_Sphere::Translate	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2
	)

gp_Sphere gp_Sphere::Translated

(

const gp_Vec &

V

)

const

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

gp_Sphere gp_Sphere::Translated	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2
	)		const

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

void gp_Sphere::UReverse

(

)

Reverses the U parametrization of the sphere reversing the YAxis.

Standard_Real gp_Sphere::Volume

(

)

const

Computes the volume of the sphere.

void gp_Sphere::VReverse

(

)

Reverses the V parametrization of the sphere reversing the ZAxis.

gp_Ax1 gp_Sphere::XAxis

(

)

const

Returns the axis X of the sphere.

gp_Ax1 gp_Sphere::YAxis

(

)

const

Returns the axis Y of the sphere.

---

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

• gp_Sphere.hxx