GC_MakeTrimmedCylinder Class Reference

Implements construction algorithms for trimmed cylinders. The result is a Geom_RectangularTrimmedSurface. A MakeTrimmedCylinder provides a framework for: More...

#include <GC_MakeTrimmedCylinder.hxx>

Inheritance diagram for GC_MakeTrimmedCylinder:

Public Member Functions
	GC_MakeTrimmedCylinder (const gp_Pnt &theP1, const gp_Pnt &theP2, const gp_Pnt &theP3)
	Creates a trimmed cylindrical surface from three points.
	GC_MakeTrimmedCylinder (const gp_Circ &theCirc, const double theHeight)
	Creates a trimmed cylindrical surface from a base circle and height.
	GC_MakeTrimmedCylinder (const gp_Ax1 &theA1, const double theRadius, const double theHeight)
	Creates a trimmed cylindrical surface from axis, radius and height.
const occ::handle< Geom_RectangularTrimmedSurface > &	Value () const
	Returns the constructed trimmed cylinder. Exceptions StdFail_NotDone if no trimmed cylinder is constructed.
	operator const occ::handle< Geom_RectangularTrimmedSurface > & () 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 trimmed cylinders. The result is a Geom_RectangularTrimmedSurface. A MakeTrimmedCylinder provides a framework for:

• defining the construction of the trimmed cylinder,
• implementing the construction algorithm, and
• consulting the results. In particular, the Value function returns the constructed trimmed cylinder.

Constructor & Destructor Documentation

GC_MakeTrimmedCylinder() [1/3]

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

Creates a trimmed cylindrical surface from three points.

Parameters

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

Note

The axis is the line passing through theP1 and theP2.

The radius is the distance from theP3 to that axis.

The height is the distance between theP1 and theP2.

GC_MakeTrimmedCylinder() [2/3]

GC_MakeTrimmedCylinder::GC_MakeTrimmedCylinder	(	const gp_Circ &	theCirc,
		const double	theHeight )

Creates a trimmed cylindrical surface from a base circle and height.

Parameters

[in]	theCirc	base circle
[in]	theHeight	trimming height

Note

The axis is the normal to the plane defined by theCirc.

theHeight can be positive or negative.

If theHeight is positive, the V parametric direction of result has the same orientation as the normal to theCirc.

If theHeight is negative, it has the opposite orientation.

GC_MakeTrimmedCylinder() [3/3]

GC_MakeTrimmedCylinder::GC_MakeTrimmedCylinder	(	const gp_Ax1 &	theA1,
		const double	theRadius,
		const double	theHeight )

Creates a trimmed cylindrical surface from axis, radius and height.

Parameters

[in]	theA1	cylinder axis
[in]	theRadius	cylinder radius
[in]	theHeight	trimming height

Note

Status is gce_NegativeRadius if theRadius is less than zero.

theHeight can be positive or negative.

If theHeight is positive, the V parametric direction of result has the same orientation as theA1.

If theHeight is negative, it has the opposite orientation.

Member Function Documentation

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

GC_MakeTrimmedCylinder::operator const occ::handle< Geom_RectangularTrimmedSurface > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_RectangularTrimmedSurface > & GC_MakeTrimmedCylinder::Value

(

)

const

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

Returns

resulting trimmed cylindrical surface

---

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

• GC_MakeTrimmedCylinder.hxx