GC_MakeCylindricalSurface Class Reference

Implements construction algorithms for cylindrical surfaces. Supported constructions include: More...

#include <GC_MakeCylindricalSurface.hxx>

Inheritance diagram for GC_MakeCylindricalSurface:

Public Member Functions
	GC_MakeCylindricalSurface (const gp_Ax2 &theA2, const double theRadius)
	Creates a cylindrical surface from axis placement and radius.
	GC_MakeCylindricalSurface (const gp_Cylinder &theC)
	Creates a cylindrical surface from a gp_Cylinder.
	GC_MakeCylindricalSurface (const gp_Cylinder &theCyl, const gp_Pnt &thePoint)
	Creates a cylindrical surface parallel to the input cylinder and passing through the input point.
	GC_MakeCylindricalSurface (const gp_Cylinder &theCyl, const double theDist)
	Creates a cylindrical surface parallel to the input cylinder at signed distance.
	GC_MakeCylindricalSurface (const gp_Pnt &theP1, const gp_Pnt &theP2, const gp_Pnt &theP3)
	Creates a cylindrical surface passing through three points.
	GC_MakeCylindricalSurface (const gp_Ax1 &theAxis, const double theRadius)
	Creates a cylindrical surface from axis and radius.
	GC_MakeCylindricalSurface (const gp_Circ &theCirc)
	Creates a cylindrical surface from its circular base.
const occ::handle< Geom_CylindricalSurface > &	Value () const
	Returns the constructed cylinder. Exceptions StdFail_NotDone if no cylinder is constructed.
	operator const occ::handle< Geom_CylindricalSurface > & () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from GC_Root
bool	IsDone () const
	Returns true if the construction is successful.
bool	IsError () const
	Returns true if the construction has failed.
gce_ErrorType	Status () const
	Returns the status of the construction:

Additional Inherited Members
Protected Attributes inherited from GC_Root
gce_ErrorType	TheError

Detailed Description

Implements construction algorithms for cylindrical surfaces. Supported constructions include:

• a cylindrical surface from axis placement and radius;
• conversion from gp_Cylinder;
• an offset/parallel cylindrical surface;
• a cylindrical surface through three points;
• a cylindrical surface from axis and radius;
• a cylindrical surface from circular base. The local coordinate system of the CylindricalSurface is defined with an axis placement (see class ElementarySurface).

The "ZAxis" is the symmetry axis of the CylindricalSurface, it gives the direction of increasing parametric value V.

The parametrization range is : U [0, 2*PI], V ]- infinite, + infinite[

The "XAxis" and the "YAxis" define the placement plane of the surface (Z = 0, and parametric value V = 0) perpendicular to the symmetry axis. The "XAxis" defines the origin of the parameter U = 0. The trigonometric sense gives the positive orientation for the parameter U.

Constructor & Destructor Documentation

GC_MakeCylindricalSurface() [1/7]

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

Creates a cylindrical surface from axis placement and radius.

Parameters

[in]	theA2	local coordinate system
[in]	theRadius	cylinder radius

Note

theA2 defines the local coordinate system of the cylindrical surface.

The "ZDirection" of theA2 defines the direction of the surface axis of symmetry.

The created surface is parametrized such that the normal vector (N = D1U ^ D1V) is oriented towards the "outside region".

It is valid to create a cylindrical surface with theRadius = 0.0.

Status is gce_NegativeRadius if theRadius < 0.0.

GC_MakeCylindricalSurface() [2/7]

GC_MakeCylindricalSurface::GC_MakeCylindricalSurface

(

const gp_Cylinder &

theC

)

Creates a cylindrical surface from a gp_Cylinder.

Parameters

[in]

theC

source cylinder

GC_MakeCylindricalSurface() [3/7]

GC_MakeCylindricalSurface::GC_MakeCylindricalSurface	(	const gp_Cylinder &	theCyl,
		const gp_Pnt &	thePoint )

Creates a cylindrical surface parallel to the input cylinder and passing through the input point.

Parameters

[in]	theCyl	source cylinder
[in]	thePoint	point on resulting surface

GC_MakeCylindricalSurface() [4/7]

GC_MakeCylindricalSurface::GC_MakeCylindricalSurface	(	const gp_Cylinder &	theCyl,
		const double	theDist )

Creates a cylindrical surface parallel to the input cylinder at signed distance.

Parameters

[in]	theCyl	source cylinder
[in]	theDist	signed offset distance

Note

The result radius is the absolute value of (source radius + signed distance).

GC_MakeCylindricalSurface() [5/7]

GC_MakeCylindricalSurface::GC_MakeCylindricalSurface	(	const gp_Pnt &	theP1,
		const gp_Pnt &	theP2,
		const gp_Pnt &	theP3 )

Creates a cylindrical surface passing through three points.

Parameters

[in]	theP1	first axis point
[in]	theP2	second axis point
[in]	theP3	point defining radius

Note

The axis is defined by points theP1 and theP2, and radius is the distance between point theP3 and that axis.

GC_MakeCylindricalSurface() [6/7]

GC_MakeCylindricalSurface::GC_MakeCylindricalSurface	(	const gp_Ax1 &	theAxis,
		const double	theRadius )

Creates a cylindrical surface from axis and radius.

Parameters

[in]	theAxis	cylinder axis
[in]	theRadius	cylinder radius

GC_MakeCylindricalSurface() [7/7]

GC_MakeCylindricalSurface::GC_MakeCylindricalSurface

(

const gp_Circ &

theCirc

)

Creates a cylindrical surface from its circular base.

Parameters

[in]

theCirc

base circle

Member Function Documentation

operator const occ::handle< Geom_CylindricalSurface > &()

GC_MakeCylindricalSurface::operator const occ::handle< Geom_CylindricalSurface > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_CylindricalSurface > & GC_MakeCylindricalSurface::Value

(

)

const

Returns the constructed cylinder. Exceptions StdFail_NotDone if no cylinder is constructed.

Returns

resulting cylindrical surface

---

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

• GC_MakeCylindricalSurface.hxx