GC_MakeLine Class Reference

This class implements the following algorithms used to create a Line from Geom. More...

#include <GC_MakeLine.hxx>

Inheritance diagram for GC_MakeLine:

Public Member Functions
	GC_MakeLine (const gp_Ax1 &theA1)
	Creates a line located in 3D space with the axis placement A1.
	GC_MakeLine (const gp_Lin &theL)
	Creates a line from a non-persistent line from package gp.
	GC_MakeLine (const gp_Pnt &theP, const gp_Dir &theV)
	Creates a line from point and direction.
	GC_MakeLine (const gp_Lin &theLin, const gp_Pnt &thePoint)
	Creates a line parallel to the input line and passing through the input point.
	GC_MakeLine (const gp_Pnt &theP1, const gp_Pnt &theP2)
	Creates a line passing through two points.
const occ::handle< Geom_Line > &	Value () const
	Returns the constructed line. Exceptions StdFail_NotDone if no line is constructed.
	operator const occ::handle< Geom_Line > & () 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

This class implements the following algorithms used to create a Line from Geom.

• Create a Line parallel to another and passing through a point.
• Create a Line passing through 2 points. A MakeLine object provides a framework for:
• defining the construction of the line,
• implementing the construction algorithm, and
• consulting the results. In particular, the Value function returns the constructed line.

Constructor & Destructor Documentation

GC_MakeLine() [1/5]

GC_MakeLine::GC_MakeLine

(

const gp_Ax1 &

theA1

)

Creates a line located in 3D space with the axis placement A1.

Parameters

[in]

theA1

line axis placement

Note

The location of theA1 is the origin of the line.

GC_MakeLine() [2/5]

GC_MakeLine::GC_MakeLine

(

const gp_Lin &

theL

)

Creates a line from a non-persistent line from package gp.

Parameters

[in]

theL

source line

GC_MakeLine() [3/5]

GC_MakeLine::GC_MakeLine	(	const gp_Pnt &	theP,
		const gp_Dir &	theV )

Creates a line from point and direction.

Parameters

[in]	theP	line origin
[in]	theV	line direction

GC_MakeLine() [4/5]

GC_MakeLine::GC_MakeLine	(	const gp_Lin &	theLin,
		const gp_Pnt &	thePoint )

Creates a line parallel to the input line and passing through the input point.

Parameters

[in]	theLin	source line
[in]	thePoint	point on resulting line

GC_MakeLine() [5/5]

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

Creates a line passing through two points.

Parameters

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

Note

Construction fails with gce_ConfusedPoints if the two points are coincident.

Member Function Documentation

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

GC_MakeLine::operator const occ::handle< Geom_Line > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_Line > & GC_MakeLine::Value

(

)

const

Returns the constructed line. Exceptions StdFail_NotDone if no line is constructed.

Returns

resulting line

---

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

• GC_MakeLine.hxx