gce_MakeLin2d Class Reference

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

#include <gce_MakeLin2d.hxx>

Inheritance diagram for gce_MakeLin2d:

Public Member Functions
	gce_MakeLin2d (const gp_Ax2d &A)
	Creates a line located with A.
	gce_MakeLin2d (const gp_Pnt2d &P, const gp_Dir2d &V)
	gce_MakeLin2d (const double A, const double B, const double C)
	Creates the line from the equation A*X + B*Y + C = 0.0.
	gce_MakeLin2d (const gp_Lin2d &Lin, const double Dist)
	Creates a line parallel to input line at signed distance.
	gce_MakeLin2d (const gp_Lin2d &Lin, const gp_Pnt2d &Point)
	Creates a line parallel to input line and passing through a point.
	gce_MakeLin2d (const gp_Pnt2d &P1, const gp_Pnt2d &P2)
	Creates a line passing through two points.
const gp_Lin2d &	Value () const
	Returns the constructed line. Exceptions StdFail_NotDone if no line is constructed.
gp_Lin2d	Operator () const
	Alias for Value() returning a copy.
	operator gp_Lin2d () 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_Lin2d. Supported constructions include:

• line from axis placement;
• line from point and direction;
• line from cartesian equation;
• parallel line through point or at signed distance;
• line through two points.

Constructor & Destructor Documentation

gce_MakeLin2d() [1/6]

gce_MakeLin2d::gce_MakeLin2d

(

const gp_Ax2d &

A

)

Creates a line located with A.

Note

The location of A is the line origin.

Parameters

[in]

A

local coordinate system

gce_MakeLin2d() [2/6]

gce_MakeLin2d::gce_MakeLin2d	(	const gp_Pnt2d &	P,
		const gp_Dir2d &	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_MakeLin2d() [3/6]

gce_MakeLin2d::gce_MakeLin2d	(	const double	A,
		const double	B,
		const double	C )

Creates the line from the equation A*X + B*Y + C = 0.0.

Note

Construction fails with gce_NullAxis if A*A + B*B <= gp::Resolution().

Parameters

[in]	A	equation coefficient A
[in]	B	equation coefficient B
[in]	C	equation coefficient C

gce_MakeLin2d() [4/6]

gce_MakeLin2d::gce_MakeLin2d	(	const gp_Lin2d &	Lin,
		const double	Dist )

Creates a line parallel to input line at signed distance.

Note

If Dist is positive, the result is on the right side of Lin (in line local orientation), otherwise on the left.

Parameters

[in]	Lin	source line
[in]	Dist	signed distance

gce_MakeLin2d() [5/6]

gce_MakeLin2d::gce_MakeLin2d	(	const gp_Lin2d &	Lin,
		const gp_Pnt2d &	Point )

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

Parameters

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

gce_MakeLin2d() [6/6]

gce_MakeLin2d::gce_MakeLin2d	(	const gp_Pnt2d &	P1,
		const gp_Pnt2d &	P2 )

Creates a line passing through two points.

Note

Construction fails with gce_ConfusedPoints if P1 and P2 are coincident.

Parameters

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

Member Function Documentation

Operator()

gp_Lin2d gce_MakeLin2d::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Lin2d()

gce_MakeLin2d::operator gp_Lin2d ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Lin2d & gce_MakeLin2d::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:

• gce_MakeLin2d.hxx