BRepPrimAPI_MakeTorus Class Reference

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

#include <BRepPrimAPI_MakeTorus.hxx>

Inheritance diagram for BRepPrimAPI_MakeTorus:

Public Member Functions
	BRepPrimAPI_MakeTorus (const Standard_Real R1, const Standard_Real R2)
	Make a torus.
	BRepPrimAPI_MakeTorus (const Standard_Real R1, const Standard_Real R2, const Standard_Real angle)
	Make a section of a torus.
	BRepPrimAPI_MakeTorus (const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2)
	Make a torus with angles on the small circle.
	BRepPrimAPI_MakeTorus (const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle)
	Make a torus with angles on the small circle.
	BRepPrimAPI_MakeTorus (const gp_Ax2 &Axes, const Standard_Real R1, const Standard_Real R2)
	Make a torus.
	BRepPrimAPI_MakeTorus (const gp_Ax2 &Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle)
	Make a section of a torus.
	BRepPrimAPI_MakeTorus (const gp_Ax2 &Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2)
	Make a torus.
	BRepPrimAPI_MakeTorus (const gp_Ax2 &Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle)
	Make a section of a torus of radii R1 R2. For all algorithms The resulting shape is composed of.
Standard_Address	OneAxis ()
	Returns the algorithm.
BRepPrim_Torus &	Torus ()
	Returns the algorithm.
Public Member Functions inherited from BRepPrimAPI_MakeOneAxis
virtual 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 TopTools_ListOfShape &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape .
virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape .
virtual Standard_Boolean	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 Standard_Boolean	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
TopTools_ListOfShape	myGenerated

Detailed Description

Describes functions to build tori or portions of tori. A MakeTorus object provides a framework for:

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

Constructor & Destructor Documentation

BRepPrimAPI_MakeTorus() [1/8]

BRepPrimAPI_MakeTorus::BRepPrimAPI_MakeTorus	(	const Standard_Real	R1,
		const Standard_Real	R2 )

Make a torus.

Parameters

[in]	R1	distance from the center of the pipe to the center of the torus
[in]	R2	radius of the pipe

BRepPrimAPI_MakeTorus() [2/8]

BRepPrimAPI_MakeTorus::BRepPrimAPI_MakeTorus	(	const Standard_Real	R1,
		const Standard_Real	R2,
		const Standard_Real	angle )

Make a section of a torus.

Parameters

[in]	R1	distance from the center of the pipe to the center of the torus
[in]	R2	radius of the pipe
[in]	angle	angle to create a torus pipe segment

BRepPrimAPI_MakeTorus() [3/8]

BRepPrimAPI_MakeTorus::BRepPrimAPI_MakeTorus	(	const Standard_Real	R1,
		const Standard_Real	R2,
		const Standard_Real	angle1,
		const Standard_Real	angle2 )

Make a torus with angles on the small circle.

Parameters

[in]	R1	distance from the center of the pipe to the center of the torus
[in]	R2	radius of the pipe
[in]	angle1	first angle to create a torus ring segment
[in]	angle2	second angle to create a torus ring segment

BRepPrimAPI_MakeTorus() [4/8]

BRepPrimAPI_MakeTorus::BRepPrimAPI_MakeTorus	(	const Standard_Real	R1,
		const Standard_Real	R2,
		const Standard_Real	angle1,
		const Standard_Real	angle2,
		const Standard_Real	angle )

Make a torus with angles on the small circle.

Parameters

[in]	R1	distance from the center of the pipe to the center of the torus
[in]	R2	radius of the pipe
[in]	angle1	first angle to create a torus ring segment
[in]	angle2	second angle to create a torus ring segment
[in]	angle	angle to create a torus pipe segment

BRepPrimAPI_MakeTorus() [5/8]

BRepPrimAPI_MakeTorus::BRepPrimAPI_MakeTorus	(	const gp_Ax2 &	Axes,
		const Standard_Real	R1,
		const Standard_Real	R2 )

Make a torus.

Parameters

[in]	Axes	coordinate system for the construction of the sphere
[in]	R1	distance from the center of the pipe to the center of the torus
[in]	R2	radius of the pipe

BRepPrimAPI_MakeTorus() [6/8]

BRepPrimAPI_MakeTorus::BRepPrimAPI_MakeTorus	(	const gp_Ax2 &	Axes,
		const Standard_Real	R1,
		const Standard_Real	R2,
		const Standard_Real	angle )

Make a section of a torus.

Parameters

[in]	Axes	coordinate system for the construction of the sphere
[in]	R1	distance from the center of the pipe to the center of the torus
[in]	R2	radius of the pipe
[in]	angle	angle to create a torus pipe segment

BRepPrimAPI_MakeTorus() [7/8]

BRepPrimAPI_MakeTorus::BRepPrimAPI_MakeTorus	(	const gp_Ax2 &	Axes,
		const Standard_Real	R1,
		const Standard_Real	R2,
		const Standard_Real	angle1,
		const Standard_Real	angle2 )

Make a torus.

Parameters

[in]	Axes	coordinate system for the construction of the sphere
[in]	R1	distance from the center of the pipe to the center of the torus
[in]	R2	radius of the pipe
[in]	angle1	first angle to create a torus ring segment
[in]	angle2	second angle to create a torus ring segment

BRepPrimAPI_MakeTorus() [8/8]

BRepPrimAPI_MakeTorus::BRepPrimAPI_MakeTorus	(	const gp_Ax2 &	Axes,
		const Standard_Real	R1,
		const Standard_Real	R2,
		const Standard_Real	angle1,
		const Standard_Real	angle2,
		const Standard_Real	angle )

Make a section of a torus of radii R1 R2. For all algorithms The resulting shape is composed of.

• a lateral toroidal face,
• two conical faces (defined by the equation v = angle1 and v = angle2) if the sphere is truncated in the v parametric direction (they may be cylindrical faces in some particular conditions), and in case of a portion of torus, two planar faces to close the shape.(in the planes u = 0 and u = angle). Notes:
• The u parameter corresponds to a rotation angle around the Z axis.
• The circle whose radius is equal to the minor radius, located in the plane defined by the X axis and the Z axis, centered on the X axis, on its positive side, and positioned at a distance from the origin equal to the major radius, is the reference circle of the torus. The rotation around an axis parallel to the Y axis and passing through the center of the reference circle gives the v parameter on the reference circle. The X axis gives the origin of the v parameter. Near 0, as v increases, the Z coordinate decreases.

Member Function Documentation

OneAxis()

Standard_Address BRepPrimAPI_MakeTorus::OneAxis ( )

virtual

Returns the algorithm.

Implements BRepPrimAPI_MakeOneAxis.

Torus()

BRepPrim_Torus & BRepPrimAPI_MakeTorus::Torus

(

)

Returns the algorithm.

---

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

• BRepPrimAPI_MakeTorus.hxx