gp_Cylinder Class Reference

Describes an infinite cylindrical surface. A cylinder is defined by its radius and positioned in space with a coordinate system (a gp_Ax3 object), the "main Axis" of which is the axis of the cylinder. This coordinate system is the "local coordinate system" of the cylinder. Note: when a gp_Cylinder cylinder is converted into a Geom_CylindricalSurface cylinder, some implicit properties of its local coordinate system are used explicitly: More...

#include <gp_Cylinder.hxx>

Public Member Functions
	gp_Cylinder ()
	Creates a indefinite cylinder. More...
	gp_Cylinder (const gp_Ax3 &A3, const Standard_Real Radius)
	Creates a cylinder of radius Radius, whose axis is the "main Axis" of A3. A3 is the local coordinate system of the cylinder. Raises ConstructionErrord if R < 0.0. More...
void	SetAxis (const gp_Ax1 &A1)
	Changes the symmetry axis of the cylinder. Raises ConstructionError if the direction of A1 is parallel to the "XDirection" of the coordinate system of the cylinder. More...
void	SetLocation (const gp_Pnt &Loc)
	Changes the location of the surface. More...
void	SetPosition (const gp_Ax3 &A3)
	Change the local coordinate system of the surface. More...
void	SetRadius (const Standard_Real R)
	Modifies the radius of this cylinder. Exceptions Standard_ConstructionError if R is negative. More...
void	UReverse ()
	Reverses the U parametrization of the cylinder reversing the YAxis. More...
void	VReverse ()
	Reverses the V parametrization of the plane reversing the Axis. More...
Standard_Boolean	Direct () const
	Returns true if the local coordinate system of this cylinder is right-handed. More...
const gp_Ax1 &	Axis () const
	Returns the symmetry axis of the cylinder. 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 coordinate 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...
const gp_Pnt &	Location () const
	Returns the "Location" point of the cylinder. More...
const gp_Ax3 &	Position () const
	Returns the local coordinate system of the cylinder. More...
Standard_Real	Radius () const
	Returns the radius of the cylinder. More...
gp_Ax1	XAxis () const
	Returns the axis X of the cylinder. More...
gp_Ax1	YAxis () const
	Returns the axis Y of the cylinder. More...
void	Mirror (const gp_Pnt &P)
gp_Cylinder	Mirrored (const gp_Pnt &P) const
	Performs the symmetrical transformation of a cylinder with respect to the point P which is the center of the symmetry. More...
void	Mirror (const gp_Ax1 &A1)
gp_Cylinder	Mirrored (const gp_Ax1 &A1) const
	Performs the symmetrical transformation of a cylinder with respect to an axis placement which is the axis of the symmetry. More...
void	Mirror (const gp_Ax2 &A2)
gp_Cylinder	Mirrored (const gp_Ax2 &A2) const
	Performs the symmetrical transformation of a cylinder 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_Cylinder	Rotated (const gp_Ax1 &A1, const Standard_Real Ang) const
	Rotates a cylinder. 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_Cylinder	Scaled (const gp_Pnt &P, const Standard_Real S) const
	Scales a cylinder. S is the scaling value. The absolute value of S is used to scale the cylinder. More...
void	Transform (const gp_Trsf &T)
gp_Cylinder	Transformed (const gp_Trsf &T) const
	Transforms a cylinder with the transformation T from class Trsf. More...
void	Translate (const gp_Vec &V)
gp_Cylinder	Translated (const gp_Vec &V) const
	Translates a cylinder 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_Cylinder	Translated (const gp_Pnt &P1, const gp_Pnt &P2) const
	Translates a cylinder from the point P1 to the point P2. More...

Detailed Description

Describes an infinite cylindrical surface. A cylinder is defined by its radius and positioned in space with a coordinate system (a gp_Ax3 object), the "main Axis" of which is the axis of the cylinder. This coordinate system is the "local coordinate system" of the cylinder. Note: when a gp_Cylinder cylinder is converted into a Geom_CylindricalSurface cylinder, 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 cylinder and the origin of the parameters,
• its implicit orientation (right-handed or left-handed) gives an orientation (direct or indirect) to the Geom_CylindricalSurface cylinder. See Also gce_MakeCylinder which provides functions for more complex cylinder constructions Geom_CylindricalSurface which provides additional functions for constructing cylinders and works, in particular, with the parametric equations of cylinders gp_Ax3

Constructor & Destructor Documentation

gp_Cylinder() [1/2]

gp_Cylinder::gp_Cylinder

(

)

Creates a indefinite cylinder.

gp_Cylinder() [2/2]

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

Creates a cylinder of radius Radius, whose axis is the "main Axis" of A3. A3 is the local coordinate system of the cylinder. Raises ConstructionErrord if R < 0.0.

Member Function Documentation

Axis()

const gp_Ax1& gp_Cylinder::Axis

(

)

const

Returns the symmetry axis of the cylinder.

Coefficients()

void gp_Cylinder::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 coordinate 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.

Direct()

Standard_Boolean gp_Cylinder::Direct

(

)

const

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

Location()

const gp_Pnt& gp_Cylinder::Location

(

)

const

Returns the "Location" point of the cylinder.

Mirror() [1/3]

void gp_Cylinder::Mirror

(

const gp_Pnt &

P

)

Mirror() [2/3]

void gp_Cylinder::Mirror

(

const gp_Ax1 &

A1

)

Mirror() [3/3]

void gp_Cylinder::Mirror

(

const gp_Ax2 &

A2

)

Mirrored() [1/3]

gp_Cylinder gp_Cylinder::Mirrored

(

const gp_Pnt &

P

)

const

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

Mirrored() [2/3]

gp_Cylinder gp_Cylinder::Mirrored

(

const gp_Ax1 &

A1

)

const

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

Mirrored() [3/3]

gp_Cylinder gp_Cylinder::Mirrored

(

const gp_Ax2 &

A2

)

const

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

Position()

const gp_Ax3& gp_Cylinder::Position

(

)

const

Returns the local coordinate system of the cylinder.

Radius()

Standard_Real gp_Cylinder::Radius

(

)

const

Returns the radius of the cylinder.

Rotate()

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

Rotated()

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

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

Scale()

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

Scaled()

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

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

SetAxis()

void gp_Cylinder::SetAxis

(

const gp_Ax1 &

A1

)

Changes the symmetry axis of the cylinder. Raises ConstructionError if the direction of A1 is parallel to the "XDirection" of the coordinate system of the cylinder.

SetLocation()

void gp_Cylinder::SetLocation

(

const gp_Pnt &

Loc

)

Changes the location of the surface.

SetPosition()

void gp_Cylinder::SetPosition

(

const gp_Ax3 &

A3

)

Change the local coordinate system of the surface.

SetRadius()

void gp_Cylinder::SetRadius

(

const Standard_Real

R

)

Modifies the radius of this cylinder. Exceptions Standard_ConstructionError if R is negative.

Transform()

void gp_Cylinder::Transform

(

const gp_Trsf &

T

)

Transformed()

gp_Cylinder gp_Cylinder::Transformed

(

const gp_Trsf &

T

)

const

Transforms a cylinder with the transformation T from class Trsf.

Translate() [1/2]

void gp_Cylinder::Translate

(

const gp_Vec &

V

)

Translate() [2/2]

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

Translated() [1/2]

gp_Cylinder gp_Cylinder::Translated

(

const gp_Vec &

V

)

const

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

Translated() [2/2]

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

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

UReverse()

void gp_Cylinder::UReverse

(

)

Reverses the U parametrization of the cylinder reversing the YAxis.

VReverse()

void gp_Cylinder::VReverse

(

)

Reverses the V parametrization of the plane reversing the Axis.

XAxis()

gp_Ax1 gp_Cylinder::XAxis

(

)

const

Returns the axis X of the cylinder.

YAxis()

gp_Ax1 gp_Cylinder::YAxis

(

)

const

Returns the axis Y of the cylinder.

---

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

• gp_Cylinder.hxx