Open CASCADE Technology  7.7.0.dev

# 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 &theA3, const Standard_Real theRadius)
Creates a cylinder of radius Radius, whose axis is the "main Axis" of theA3. theA3 is the local coordinate system of the cylinder. Raises ConstructionErrord if theRadius < 0.0. More...

void SetAxis (const gp_Ax1 &theA1)
Changes the symmetry axis of the cylinder. Raises ConstructionError if the direction of theA1 is parallel to the "XDirection" of the coordinate system of the cylinder. More...

void SetLocation (const gp_Pnt &theLoc)
Changes the location of the surface. More...

void SetPosition (const gp_Ax3 &theA3)
Change the local coordinate system of the surface. More...

void SetRadius (const Standard_Real theR)
Modifies the radius of this cylinder. Exceptions Standard_ConstructionError if theR 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_Ax1Axis () const
Returns the symmetry axis of the cylinder. More...

void Coefficients (Standard_Real &theA1, Standard_Real &theA2, Standard_Real &theA3, Standard_Real &theB1, Standard_Real &theB2, Standard_Real &theB3, Standard_Real &theC1, Standard_Real &theC2, Standard_Real &theC3, Standard_Real &theD) const
Computes the coefficients of the implicit equation of the quadric in the absolute cartesian coordinate 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. More...

const gp_PntLocation () const
Returns the "Location" point of the cylinder. More...

const gp_Ax3Position () 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 &theP)

gp_Cylinder Mirrored (const gp_Pnt &theP) const
Performs the symmetrical transformation of a cylinder with respect to the point theP which is the center of the symmetry. More...

void Mirror (const gp_Ax1 &theA1)

gp_Cylinder Mirrored (const gp_Ax1 &theA1) 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 &theA2)

gp_Cylinder Mirrored (const gp_Ax2 &theA2) const
Performs the symmetrical transformation of a cylinder with respect to a plane. The axis placement theA2 locates the plane of the of the symmetry : (Location, XDirection, YDirection). More...

void Rotate (const gp_Ax1 &theA1, const Standard_Real theAng)

gp_Cylinder Rotated (const gp_Ax1 &theA1, const Standard_Real theAng) const
Rotates a cylinder. theA1 is the axis of the rotation. theAng is the angular value of the rotation in radians. More...

void Scale (const gp_Pnt &theP, const Standard_Real theS)

gp_Cylinder Scaled (const gp_Pnt &theP, const Standard_Real theS) const
Scales a cylinder. theS is the scaling value. The absolute value of theS is used to scale the cylinder. More...

void Transform (const gp_Trsf &theT)

gp_Cylinder Transformed (const gp_Trsf &theT) const
Transforms a cylinder with the transformation theT from class Trsf. More...

void Translate (const gp_Vec &theV)

gp_Cylinder Translated (const gp_Vec &theV) const
Translates a cylinder in the direction of the vector theV. The magnitude of the translation is the vector's magnitude. More...

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

gp_Cylinder Translated (const gp_Pnt &theP1, const gp_Pnt &theP2) const
Translates a cylinder from the point theP1 to the point theP2. 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

## ◆ gp_Cylinder() [1/2]

 gp_Cylinder::gp_Cylinder ( )
inline

Creates a indefinite cylinder.

## ◆ gp_Cylinder() [2/2]

 gp_Cylinder::gp_Cylinder ( const gp_Ax3 & theA3, const Standard_Real theRadius )
inline

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

## ◆ Axis()

 const gp_Ax1& gp_Cylinder::Axis ( ) const
inline

Returns the symmetry axis of the cylinder.

## ◆ Coefficients()

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

Computes the coefficients of the implicit equation of the quadric in the absolute cartesian coordinate 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()

 Standard_Boolean gp_Cylinder::Direct ( ) const
inline

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

## ◆ Location()

 const gp_Pnt& gp_Cylinder::Location ( ) const
inline

Returns the "Location" point of the cylinder.

## ◆ Mirror() [1/3]

 void gp_Cylinder::Mirror ( const gp_Ax1 & theA1 )

## ◆ Mirror() [2/3]

 void gp_Cylinder::Mirror ( const gp_Ax2 & theA2 )

## ◆ Mirror() [3/3]

 void gp_Cylinder::Mirror ( const gp_Pnt & theP )

## ◆ Mirrored() [1/3]

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

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

## ◆ Mirrored() [2/3]

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

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

## ◆ Mirrored() [3/3]

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

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

## ◆ Position()

 const gp_Ax3& gp_Cylinder::Position ( ) const
inline

Returns the local coordinate system of the cylinder.

 Standard_Real gp_Cylinder::Radius ( ) const
inline

Returns the radius of the cylinder.

## ◆ Rotate()

 void gp_Cylinder::Rotate ( const gp_Ax1 & theA1, const Standard_Real theAng )
inline

## ◆ Rotated()

 gp_Cylinder gp_Cylinder::Rotated ( const gp_Ax1 & theA1, const Standard_Real theAng ) const
inline

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

## ◆ Scale()

 void gp_Cylinder::Scale ( const gp_Pnt & theP, const Standard_Real theS )
inline

## ◆ Scaled()

 gp_Cylinder gp_Cylinder::Scaled ( const gp_Pnt & theP, const Standard_Real theS ) const
inline

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

## ◆ SetAxis()

 void gp_Cylinder::SetAxis ( const gp_Ax1 & theA1 )
inline

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

## ◆ SetLocation()

 void gp_Cylinder::SetLocation ( const gp_Pnt & theLoc )
inline

Changes the location of the surface.

## ◆ SetPosition()

 void gp_Cylinder::SetPosition ( const gp_Ax3 & theA3 )
inline

Change the local coordinate system of the surface.

 void gp_Cylinder::SetRadius ( const Standard_Real theR )
inline

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

## ◆ Transform()

 void gp_Cylinder::Transform ( const gp_Trsf & theT )
inline

## ◆ Transformed()

 gp_Cylinder gp_Cylinder::Transformed ( const gp_Trsf & theT ) const
inline

Transforms a cylinder with the transformation theT from class Trsf.

## ◆ Translate() [1/2]

 void gp_Cylinder::Translate ( const gp_Pnt & theP1, const gp_Pnt & theP2 )
inline

## ◆ Translate() [2/2]

 void gp_Cylinder::Translate ( const gp_Vec & theV )
inline

## ◆ Translated() [1/2]

 gp_Cylinder gp_Cylinder::Translated ( const gp_Pnt & theP1, const gp_Pnt & theP2 ) const
inline

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

## ◆ Translated() [2/2]

 gp_Cylinder gp_Cylinder::Translated ( const gp_Vec & theV ) const
inline

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

## ◆ UReverse()

 void gp_Cylinder::UReverse ( )
inline

Reverses the U parametrization of the cylinder reversing the YAxis.

## ◆ VReverse()

 void gp_Cylinder::VReverse ( )
inline

Reverses the V parametrization of the plane reversing the Axis.

## ◆ XAxis()

 gp_Ax1 gp_Cylinder::XAxis ( ) const
inline

Returns the axis X of the cylinder.

## ◆ YAxis()

 gp_Ax1 gp_Cylinder::YAxis ( ) const
inline

Returns the axis Y of the cylinder.

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