gce_MakePln Class Reference

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

#include <gce_MakePln.hxx>

Inheritance diagram for gce_MakePln:

Public Member Functions
	gce_MakePln (const gp_Ax2 &A2)
	The coordinate system of the plane is defined with the axis placement A2. The "Direction" of A2 defines the normal to the plane. The "Location" of A2 defines the location (origin) of the plane. The "XDirection" and "YDirection" of A2 define the "XAxis" and the "YAxis" of the plane used to parametrize the plane.
	gce_MakePln (const gp_Pnt &P, const gp_Dir &V)
	Creates a plane with the "Location" point.
	gce_MakePln (const double A, const double B, const double C, const double D)
	Creates a plane from its cartesian equation : A * X + B * Y + C * Z + D = 0.0.
	gce_MakePln (const gp_Pln &Pln, const gp_Pnt &Point)
	Creates a plane parallel to input plane and passing through a point.
	gce_MakePln (const gp_Pln &Pln, const double Dist)
	Creates a plane parallel to input plane at signed distance.
	gce_MakePln (const gp_Pnt &P1, const gp_Pnt &P2, const gp_Pnt &P3)
	Creates a plane through three points.
	gce_MakePln (const gp_Pnt &P1, const gp_Pnt &P2)
	Creates a plane through P1, normal to direction (P1,P2).
	gce_MakePln (const gp_Ax1 &Axis)
	Make a pln passing through the location of <Axis>and normal to the Direction of <Axis>.
const gp_Pln &	Value () const
	Returns the constructed plane. Exceptions StdFail_NotDone if no plane is constructed.
gp_Pln	Operator () const
	Alias for Value() returning a copy.
	operator gp_Pln () 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_Pln. Supported constructions include:

• plane from axis placement or point+normal;
• plane from cartesian equation;
• plane parallel to another plane through point or at signed distance;
• plane through two or three points;
• plane through axis location normal to axis direction.

  Note

  A plane is positioned by local coordinate system (gp_Ax3):

  • Location is the origin,
  • main direction is the plane normal,
  • XDirection and YDirection define in-plane axes.

Constructor & Destructor Documentation

gce_MakePln() [1/8]

gce_MakePln::gce_MakePln

(

const gp_Ax2 &

A2

)

The coordinate system of the plane is defined with the axis placement A2. The "Direction" of A2 defines the normal to the plane. The "Location" of A2 defines the location (origin) of the plane. The "XDirection" and "YDirection" of A2 define the "XAxis" and the "YAxis" of the plane used to parametrize the plane.

Parameters

[in]

A2

local coordinate system

gce_MakePln() [2/8]

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

Creates a plane with the "Location" point.

and the normal direction <V>.

Parameters

[in]	P	point
[in]	V	direction vector

gce_MakePln() [3/8]

gce_MakePln::gce_MakePln	(	const double	A,
		const double	B,
		const double	C,
		const double	D )

Creates a plane from its cartesian equation : A * X + B * Y + C * Z + D = 0.0.

Note

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

Parameters

[in]	A	equation coefficient A
[in]	B	equation coefficient B
[in]	C	equation coefficient C
[in]	D	equation constant term

gce_MakePln() [4/8]

gce_MakePln::gce_MakePln	(	const gp_Pln &	Pln,
		const gp_Pnt &	Point )

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

Parameters

[in]	Pln	source plane
[in]	Point	reference point

gce_MakePln() [5/8]

gce_MakePln::gce_MakePln	(	const gp_Pln &	Pln,
		const double	Dist )

Creates a plane parallel to input plane at signed distance.

Note

Positive Dist shifts along the plane normal, negative in opposite direction.

Parameters

[in]	Pln	source plane
[in]	Dist	signed distance

gce_MakePln() [6/8]

gce_MakePln::gce_MakePln	(	const gp_Pnt &	P1,
		const gp_Pnt &	P2,
		const gp_Pnt &	P3 )

Creates a plane through three points.

Note

Construction fails with gce_ColinearPoints if points are collinear.

Parameters

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

gce_MakePln() [7/8]

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

Creates a plane through P1, normal to direction (P1,P2).

Note

Construction fails with gce_ConfusedPoints if P1 and P2 coincide.

Parameters

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

gce_MakePln() [8/8]

gce_MakePln::gce_MakePln

(

const gp_Ax1 &

Axis

)

Make a pln passing through the location of <Axis>and normal to the Direction of <Axis>.

Note

This constructor always succeeds for valid Axis.

Parameters

[in]

Axis

axis definition

Member Function Documentation

Operator()

gp_Pln gce_MakePln::Operator ( ) const

inline

Alias for Value() returning a copy.

Returns

resulting object

operator gp_Pln()

gce_MakePln::operator gp_Pln ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const gp_Pln & gce_MakePln::Value

(

)

const

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

Returns

resulting plane

---

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

• gce_MakePln.hxx