gce_MakeLin Class Reference

This class implements construction algorithms for gp_Lin. Supported constructions include: More...

#include <gce_MakeLin.hxx>

Inheritance diagram for gce_MakeLin:

Public Member Functions
	gce_MakeLin (const gp_Ax1 &A1)
	Creates a line located along the axis A1.
	gce_MakeLin (const gp_Pnt &P, const gp_Dir &V)
	gce_MakeLin (const gp_Lin &Lin, const gp_Pnt &Point)
	Creates a line parallel to input line and passing through a point.
	gce_MakeLin (const gp_Pnt &P1, const gp_Pnt &P2)
	Creates a line passing through two points.
const gp_Lin &	Value () const
	Returns the constructed line. Exceptions StdFail_NotDone is raised if no line is constructed.
gp_Lin	Operator () const
	Alias for Value() returning a copy.
	operator gp_Lin () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from gce_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 gce_Root
gce_ErrorType	TheError

Detailed Description

This class implements construction algorithms for gp_Lin. Supported constructions include:

• line from axis placement;
• line from point and direction;
• parallel line through point;
• line through two points.

Constructor & Destructor Documentation

gce_MakeLin() [1/4]

gce_MakeLin::gce_MakeLin

(

const gp_Ax1 &

A1

)

Creates a line located along the axis A1.

Note

The location of A1 is the line origin.

Parameters

[in]

A1

axis placement

gce_MakeLin() [2/4]

gce_MakeLin::gce_MakeLin	(	const gp_Pnt &	P,
		const gp_Dir &	V )

is the location point (origin) of the line and <V> is the direction of the line.

Parameters

[in]	P	point
[in]	V	direction vector

gce_MakeLin() [3/4]

gce_MakeLin::gce_MakeLin	(	const gp_Lin &	Lin,
		const gp_Pnt &	Point )

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

Parameters

[in]	Lin	source line
[in]	Point	reference point

gce_MakeLin() [4/4]

gce_MakeLin::gce_MakeLin	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2 )

Creates a line passing through two points.

Note

Construction fails with gce_ConfusedPoints if points are coincident.

Parameters

[in]	P1	first point
[in]	P2	second point

Member Function Documentation

Operator()

gp_Lin gce_MakeLin::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Lin()

gce_MakeLin::operator gp_Lin ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Lin & gce_MakeLin::Value

(

)

const

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

Returns

resulting line

---

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

• gce_MakeLin.hxx