gce_MakeCylinder Class Reference

This class implements construction algorithms for gp_Cylinder. Supported constructions include: More...

#include <gce_MakeCylinder.hxx>

Inheritance diagram for gce_MakeCylinder:

Public Member Functions
	gce_MakeCylinder (const gp_Ax2 &A2, const double Radius)
	Creates a cylinder from axis placement and radius.
	gce_MakeCylinder (const gp_Cylinder &Cyl, const gp_Pnt &Point)
	Creates a cylinder coaxial to input cylinder and passing through a point.
	gce_MakeCylinder (const gp_Cylinder &Cyl, const double Dist)
	Creates a cylinder coaxial to input cylinder at signed distance.
	gce_MakeCylinder (const gp_Pnt &P1, const gp_Pnt &P2, const gp_Pnt &P3)
	Creates a cylinder from three points.
	gce_MakeCylinder (const gp_Ax1 &Axis, const double Radius)
	Makes a Cylinder by its axis <Axis> and radius <Radius>.
	gce_MakeCylinder (const gp_Circ &Circ)
	Creates a cylinder from circular base.
const gp_Cylinder &	Value () const
	Returns the constructed cylinder. Exceptions StdFail_NotDone if no cylinder is constructed.
gp_Cylinder	Operator () const
	Alias for Value() returning a copy.
	operator gp_Cylinder () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from gce_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 gce_Root
gce_ErrorType	TheError

Detailed Description

This class implements construction algorithms for gp_Cylinder. Supported constructions include:

• cylinder from axis placement and radius;
• cylinder coaxial to another, through point or at signed offset;
• cylinder from three points;
• cylinder from axis and radius;
• cylinder from circular base.

Constructor & Destructor Documentation

gce_MakeCylinder() [1/6]

gce_MakeCylinder::gce_MakeCylinder	(	const gp_Ax2 &	A2,
		const double	Radius )

Creates a cylinder from axis placement and radius.

Note

Construction fails with gce_NegativeRadius if Radius is negative.

Parameters

[in]	A2	local coordinate system
[in]	Radius	radius value

gce_MakeCylinder() [2/6]

gce_MakeCylinder::gce_MakeCylinder	(	const gp_Cylinder &	Cyl,
		const gp_Pnt &	Point )

Creates a cylinder coaxial to input cylinder and passing through a point.

Parameters

[in]	Cyl	source cylinder
[in]	Point	reference point

gce_MakeCylinder() [3/6]

gce_MakeCylinder::gce_MakeCylinder	(	const gp_Cylinder &	Cyl,
		const double	Dist )

Creates a cylinder coaxial to input cylinder at signed distance.

Note

Construction fails with gce_NegativeRadius if resulting radius is negative.

Parameters

[in]	Cyl	source cylinder
[in]	Dist	signed distance

gce_MakeCylinder() [4/6]

gce_MakeCylinder::gce_MakeCylinder	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2,
		const gp_Pnt &	P3 )

Creates a cylinder from three points.

Note

Axis is defined by points P1 and P2.

Radius is the distance from P3 to that axis.

Parameters

[in]	P1	first point
[in]	P2	second point
[in]	P3	third point

gce_MakeCylinder() [5/6]

gce_MakeCylinder::gce_MakeCylinder	(	const gp_Ax1 &	Axis,
		const double	Radius )

Makes a Cylinder by its axis <Axis> and radius <Radius>.

Parameters

[in]	Axis	axis definition
[in]	Radius	radius value

gce_MakeCylinder() [6/6]

gce_MakeCylinder::gce_MakeCylinder

(

const gp_Circ &

Circ

)

Creates a cylinder from circular base.

Note

The resulting cylinder axis equals the circle axis.

This constructor succeeds for any valid Circ.

Parameters

[in]

Circ

source circle

Member Function Documentation

Operator()

gp_Cylinder gce_MakeCylinder::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Cylinder()

gce_MakeCylinder::operator gp_Cylinder ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Cylinder & gce_MakeCylinder::Value

(

)

const

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

Returns

resulting cylinder

---

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

• gce_MakeCylinder.hxx