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 Standard_Real R, const Standard_Real H) | |
| Make a cylinder of radius R and length H. More... | |
| BRepPrimAPI_MakeCylinder (const Standard_Real R, const Standard_Real H, const Standard_Real Angle) | |
| Make a cylinder of radius R and length H with angle H. More... | |
| BRepPrimAPI_MakeCylinder (const gp_Ax2 &Axes, const Standard_Real R, const Standard_Real H) | |
| Make a cylinder of radius R and length H. More... | |
| BRepPrimAPI_MakeCylinder (const gp_Ax2 &Axes, const Standard_Real R, const Standard_Real H, const Standard_Real Angle) | |
| Make a cylinder of radius R and length H with angle H. Constructs. More... | |
| Standard_Address | OneAxis () |
| Returns the algorithm. More... | |
| BRepPrim_Cylinder & | Cylinder () |
| Returns the algorithm. More... | |
 Public Member Functions inherited from BRepPrimAPI_MakeOneAxis | |
| virtual void | Build () override |
| Stores the solid in myShape. More... | |
| const TopoDS_Face & | Face () |
| Returns the lateral face of the rotational primitive. More... | |
| operator TopoDS_Face () | |
| const TopoDS_Shell & | Shell () |
| Returns the constructed rotational primitive as a shell. More... | |
| operator TopoDS_Shell () | |
| const TopoDS_Solid & | Solid () |
| Returns the constructed rotational primitive as a solid. More... | |
| 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. More... | |
| operator TopoDS_Shape () | |
| virtual const TopTools_ListOfShape & | Generated (const TopoDS_Shape &S) |
| Returns the list of shapes generated from the shape <S>. More... | |
| virtual const TopTools_ListOfShape & | Modified (const TopoDS_Shape &S) |
| Returns the list of shapes modified from the shape <S>. More... | |
| virtual Standard_Boolean | IsDeleted (const TopoDS_Shape &S) |
| Returns true if the shape S has been deleted. More... | |
| Public Member Functions inherited from BRepBuilderAPI_Command | |
| virtual | ~BRepBuilderAPI_Command () |
| virtual Standard_Boolean | IsDone () const |
| void | Check () const |
| Raises NotDone if done is false. More... | |
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. More... | |
| void | Done () |
| Set done to true. More... | |
| void | NotDone () |
| Set done to false. More... | |
| Protected Attributes inherited from BRepBuilderAPI_MakeShape | |
| TopoDS_Shape | myShape |
| TopTools_ListOfShape | 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::BRepPrimAPI_MakeCylinder | ( | const Standard_Real | R, |
| const Standard_Real | H | ||
| ) |
Make a cylinder of radius R and length H.
| BRepPrimAPI_MakeCylinder::BRepPrimAPI_MakeCylinder | ( | const Standard_Real | R, |
| const Standard_Real | H, | ||
| const Standard_Real | Angle | ||
| ) |
Make a cylinder of radius R and length H with angle H.
| BRepPrimAPI_MakeCylinder::BRepPrimAPI_MakeCylinder | ( | const gp_Ax2 & | Axes, |
| const Standard_Real | R, | ||
| const Standard_Real | H | ||
| ) |
Make a cylinder of radius R and length H.
| BRepPrimAPI_MakeCylinder::BRepPrimAPI_MakeCylinder | ( | const gp_Ax2 & | Axes, |
| const Standard_Real | R, | ||
| const Standard_Real | H, | ||
| const Standard_Real | 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
| BRepPrim_Cylinder& BRepPrimAPI_MakeCylinder::Cylinder | ( | ) |
Returns the algorithm.
|
virtual |
Returns the algorithm.
Implements BRepPrimAPI_MakeOneAxis.
The documentation for this class was generated from the following file:
