BRepPrimAPI_MakeCylinder Class Reference

Describes functions to build cylinders or portions of cylinders. A MakeCylinder object provides a framework for: More...

#include <BRepPrimAPI_MakeCylinder.hxx>

Inheritance diagram for BRepPrimAPI_MakeCylinder:

Public Member Functions
	BRepPrimAPI_MakeCylinder (const double R, const double H)
	Make a cylinder.
	BRepPrimAPI_MakeCylinder (const double R, const double H, const double Angle)
	Make a cylinder (part cylinder).
	BRepPrimAPI_MakeCylinder (const gp_Ax2 &Axes, const double R, const double H)
	Make a cylinder of radius R and length H.
	BRepPrimAPI_MakeCylinder (const gp_Ax2 &Axes, const double R, const double H, const double Angle)
	Make a cylinder of radius R and length H with angle H. Constructs.
void *	OneAxis () override
	Returns the algorithm.
BRepPrim_Cylinder &	Cylinder ()
	Returns the algorithm.
Public Member Functions inherited from BRepPrimAPI_MakeOneAxis
void	Build (const Message_ProgressRange &theRange=Message_ProgressRange()) override
	Stores the solid in myShape.
const TopoDS_Face &	Face ()
	Returns the lateral face of the rotational primitive.
	operator TopoDS_Face ()
const TopoDS_Shell &	Shell ()
	Returns the constructed rotational primitive as a shell.
	operator TopoDS_Shell ()
const TopoDS_Solid &	Solid ()
	Returns the constructed rotational primitive as a solid.
	operator TopoDS_Solid ()
Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual const TopoDS_Shape &	Shape ()
	Returns a shape built by the shape construction algorithm. Raises exception StdFail_NotDone if the shape was not built.
	operator TopoDS_Shape ()
virtual const NCollection_List< TopoDS_Shape > &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape .
virtual const NCollection_List< TopoDS_Shape > &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape .
virtual bool	IsDeleted (const TopoDS_Shape &S)
	Returns true if the shape S has been deleted.
Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()
virtual bool	IsDone () const
void	Check () const
	Raises NotDone if done is false.

Additional Inherited Members
Protected Member Functions inherited from BRepBuilderAPI_MakeShape
	BRepBuilderAPI_MakeShape ()
Protected Member Functions inherited from BRepBuilderAPI_Command
	BRepBuilderAPI_Command ()
	Set done to False.
void	Done ()
	Set done to true.
void	NotDone ()
	Set done to false.
Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape
NCollection_List< TopoDS_Shape >	myGenerated

Detailed Description

Describes functions to build cylinders or portions of cylinders. A MakeCylinder object provides a framework for:

• defining the construction of a cylinder,
• implementing the construction algorithm, and
• consulting the result.

Constructor & Destructor Documentation

BRepPrimAPI_MakeCylinder() [1/4]

BRepPrimAPI_MakeCylinder::BRepPrimAPI_MakeCylinder	(	const double	R,
		const double	H )

Make a cylinder.

Parameters

[in]	R	cylinder radius
[in]	H	cylinder height

BRepPrimAPI_MakeCylinder() [2/4]

BRepPrimAPI_MakeCylinder::BRepPrimAPI_MakeCylinder	(	const double	R,
		const double	H,
		const double	Angle )

Make a cylinder (part cylinder).

Parameters

[in]	R	cylinder radius
[in]	H	cylinder height
[in]	Angle	defines the missing portion of the cylinder

BRepPrimAPI_MakeCylinder() [3/4]

BRepPrimAPI_MakeCylinder::BRepPrimAPI_MakeCylinder	(	const gp_Ax2 &	Axes,
		const double	R,
		const double	H )

Make a cylinder of radius R and length H.

Parameters

[in]	Axes	coordinate system for the construction of the cylinder
[in]	R	cylinder radius
[in]	H	cylinder height

BRepPrimAPI_MakeCylinder() [4/4]

BRepPrimAPI_MakeCylinder::BRepPrimAPI_MakeCylinder	(	const gp_Ax2 &	Axes,
		const double	R,
		const double	H,
		const double	Angle )

Make a cylinder of radius R and length H with angle H. Constructs.

• a cylinder of radius R and height H, or
• a portion of cylinder of radius R and height H, and of the angle Angle defining the missing portion of the cylinder. The cylinder is constructed about the "Z Axis" of either:
• the global coordinate system, or
• the local coordinate system Axes. It is limited in this coordinate system as follows:
• in the v parametric direction (the Z axis), by the two parameter values 0 and H,
• and in the u parametric direction (the rotation angle around the Z Axis), in the case of a portion of a cylinder, by the two parameter values 0 and Angle. Angle is given in radians. The resulting shape is composed of:
• a lateral cylindrical face,
• two planar faces in the planes z = 0 and z = H (in the case of a complete cylinder, these faces are circles), and
• in case of a portion of a cylinder, two additional planar faces to close the shape.(two rectangles in the planes u = 0 and u = Angle). Exceptions Standard_DomainError if:
• R is less than or equal to Precision::Confusion(), or
• H is less than or equal to Precision::Confusion().

Member Function Documentation

Cylinder()

BRepPrim_Cylinder & BRepPrimAPI_MakeCylinder::Cylinder

(

)

Returns the algorithm.

OneAxis()

void * BRepPrimAPI_MakeCylinder::OneAxis ( )

overridevirtual

Returns the algorithm.

Implements BRepPrimAPI_MakeOneAxis.

---

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

• BRepPrimAPI_MakeCylinder.hxx