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

#include <GC_MakeTrimmedCone.hxx>

Inheritance diagram for GC_MakeTrimmedCone:

[legend]

Public Member Functions
	GC_MakeTrimmedCone (const gp_Pnt &theP1, const gp_Pnt &theP2, const gp_Pnt &theP3, const gp_Pnt &theP4)
	Creates a rectangular trimmed conical surface from four points.

	GC_MakeTrimmedCone (const gp_Pnt &theP1, const gp_Pnt &theP2, const double theR1, const double theR2)
	Creates a rectangular trimmed conical surface from two points and two radii.

const occ::handle< Geom_RectangularTrimmedSurface > &	Value () const
	Returns the constructed trimmed cone. StdFail_NotDone if no trimmed cone 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 cones. The result is a Geom_RectangularTrimmedSurface. A MakeTrimmedCone provides a framework for:

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

Constructor & Destructor Documentation

◆ GC_MakeTrimmedCone() [1/2]

GC_MakeTrimmedCone::GC_MakeTrimmedCone	(	const gp_Pnt &	theP1,
		const gp_Pnt &	theP2,
		const gp_Pnt &	theP3,
		const gp_Pnt &	theP4 )

Creates a rectangular trimmed conical surface from four points.

Parameters

[in]	theP1	first axis point
[in]	theP2	second axis point
[in]	theP3	point defining first trimming section
[in]	theP4	point defining second trimming section

Note: The surface is trimmed by points P3 and P4.; The axis is defined by points P1 and P2; the base radius is the distance from point P3 to that axis.; The distance from point P4 to that axis is the radius of the section passing through P4.; Construction fails if points P1, P2, P3 and P4 are collinear, or if vector P3P4 is perpendicular/collinear to vector P1P2.

◆ GC_MakeTrimmedCone() [2/2]

GC_MakeTrimmedCone::GC_MakeTrimmedCone	(	const gp_Pnt &	theP1,
		const gp_Pnt &	theP2,
		const double	theR1,
		const double	theR2 )

Creates a rectangular trimmed conical surface from two points and two radii.

Parameters

[in]	theP1	first axis point
[in]	theP2	second axis point
[in]	theR1	radius at P1
[in]	theR2	radius at P2

Note: The two radii correspond to sections passing through the two axis points.; On failure, status is propagated from GC_MakeConicalSurface(theP1, theP2, theR1, theR2).

Member Function Documentation

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

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

inline

Conversion operator returning the constructed object.

Returns: resulting object

◆ Value()

const occ::handle< Geom_RectangularTrimmedSurface > & GC_MakeTrimmedCone::Value ( ) const

Returns the constructed trimmed cone. StdFail_NotDone if no trimmed cone is constructed.

Returns: resulting trimmed conical surface

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

GC_MakeTrimmedCone.hxx

Public Member Functions