GC_MakeSegment Class Reference

Implements construction algorithms for line segments in 3D space. The result is a Geom_TrimmedCurve. A GC_MakeSegment object provides a framework for: More...

#include <GC_MakeSegment.hxx>

Inheritance diagram for GC_MakeSegment:

Public Member Functions
	GC_MakeSegment (const gp_Pnt &theP1, const gp_Pnt &theP2)
	Creates a segment of a line from two points.
	GC_MakeSegment (const gp_Lin &theLine, const double theU1, const double theU2)
	Creates a segment of the input line between two parameters.
	GC_MakeSegment (const gp_Lin &theLine, const gp_Pnt &thePoint, const double theUlast)
	Creates a segment of the input line between a point and a parameter.
	GC_MakeSegment (const gp_Lin &theLine, const gp_Pnt &theP1, const gp_Pnt &theP2)
	Creates a segment of the input line between two points.
const occ::handle< Geom_TrimmedCurve > &	Value () const
	Returns the constructed line segment.
	operator const occ::handle< Geom_TrimmedCurve > & () 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 line segments in 3D space. The result is a Geom_TrimmedCurve. A GC_MakeSegment object provides a framework for:

• defining the construction parameters;
• running the construction algorithm;
• querying the construction status and resulting segment via Value().

Constructor & Destructor Documentation

GC_MakeSegment() [1/4]

GC_MakeSegment::GC_MakeSegment	(	const gp_Pnt &	theP1,
		const gp_Pnt &	theP2 )

Creates a segment of a line from two points.

Parameters

[in]	theP1	first point
[in]	theP2	second point

Note

Construction fails if the two points are coincident.

GC_MakeSegment() [2/4]

GC_MakeSegment::GC_MakeSegment	(	const gp_Lin &	theLine,
		const double	theU1,
		const double	theU2 )

Creates a segment of the input line between two parameters.

Parameters

[in]	theLine	source line
[in]	theU1	first parameter
[in]	theU2	second parameter

Note

Construction fails when both parameters are equal.

GC_MakeSegment() [3/4]

GC_MakeSegment::GC_MakeSegment	(	const gp_Lin &	theLine,
		const gp_Pnt &	thePoint,
		const double	theUlast )

Creates a segment of the input line between a point and a parameter.

Parameters

[in]	theLine	source line
[in]	thePoint	start point on line
[in]	theUlast	end parameter

Note

Construction fails if trimming parameters are equal.

GC_MakeSegment() [4/4]

GC_MakeSegment::GC_MakeSegment	(	const gp_Lin &	theLine,
		const gp_Pnt &	theP1,
		const gp_Pnt &	theP2 )

Creates a segment of the input line between two points.

Parameters

[in]	theLine	source line
[in]	theP1	first point
[in]	theP2	second point

Note

Construction fails if trimming parameters are equal.

Member Function Documentation

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

GC_MakeSegment::operator const occ::handle< Geom_TrimmedCurve > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_TrimmedCurve > & GC_MakeSegment::Value

(

)

const

Returns the constructed line segment.

Returns

resulting line segment

---

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

• GC_MakeSegment.hxx