gce_MakePln Class Reference

This class implements the following algorithms used to create a Plane from gp. 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 Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real 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)
	Make a Pln from gp <ThePln> parallel to another Pln <Pln> and passing through a Pnt <Point>.
	gce_MakePln (const gp_Pln &Pln, const Standard_Real Dist)
	Make a Pln from gp <ThePln> parallel to another Pln <Pln> at the distance <Dist> which can be greater or less than zero. In the first case the result is at the distance <Dist> to the plane <Pln> in the direction of the normal to <Pln>. Otherwise it is in the opposite direction.
	gce_MakePln (const gp_Pnt &P1, const gp_Pnt &P2, const gp_Pnt &P3)
	Make a Pln from gp <ThePln> passing through 3 Pnt <P1>,<P2>,<P3>. It returns false if <P1> <P2> <P3> are confused.
	gce_MakePln (const gp_Pnt &P1, const gp_Pnt &P2)
	Make a Pln from gp <ThePln> perpendicular to the line passing through <P1>,<P2>. The status is "ConfusedPoints" if <P1> <P2> are confused.
	gce_MakePln (const gp_Ax1 &Axis)
	Make a pln passing through the location of <Axis>and normal to the Direction of <Axis>. Warning - If an error occurs (that is, when IsDone returns false), the Status function returns:
const gp_Pln &	Value () const
	Returns the constructed plane. Exceptions StdFail_NotDone if no plane is constructed.
const gp_Pln &	Operator () const
	operator gp_Pln () const
Public Member Functions inherited from gce_Root
Standard_Boolean	IsDone () const
	Returns true if the construction is successful.
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 the following algorithms used to create a Plane from gp.

• Create a Pln parallel to another and passing through a point.
• Create a Pln passing through 3 points.
• Create a Pln by its normal. Defines a non-persistent plane. The plane is located in 3D space with an axis placement two axis. It is the local coordinate system of the plane.

The "Location" point and the main direction of this axis placement define the "Axis" of the plane. It is the axis normal to the plane which gives the orientation of the plane.

The "XDirection" and the "YDirection" of the axis placement define the plane ("XAxis" and "YAxis") .

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.

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>.

gce_MakePln() [3/8]

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

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

the status is "BadEquation" if Sqrt (A*A + B*B + C*C) <= Resolution from gp.

gce_MakePln() [4/8]

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

Make a Pln from gp <ThePln> parallel to another Pln <Pln> and passing through a Pnt <Point>.

gce_MakePln() [5/8]

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

Make a Pln from gp <ThePln> parallel to another Pln <Pln> at the distance <Dist> which can be greater or less than zero. In the first case the result is at the distance <Dist> to the plane <Pln> in the direction of the normal to <Pln>. Otherwise it is in the opposite direction.

gce_MakePln() [6/8]

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

Make a Pln from gp <ThePln> passing through 3 Pnt <P1>,<P2>,<P3>. It returns false if <P1> <P2> <P3> are confused.

gce_MakePln() [7/8]

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

Make a Pln from gp <ThePln> perpendicular to the line passing through <P1>,<P2>. The status is "ConfusedPoints" if <P1> <P2> are confused.

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>. Warning - If an error occurs (that is, when IsDone returns false), the Status function returns:

• gce_BadEquation if Sqrt(A*A + B*B + C*C) is less than or equal to gp::Resolution(),
• gce_ConfusedPoints if P1 and P2 are coincident, or
• gce_ColinearPoints if P1, P2 and P3 are collinear.

Member Function Documentation

Operator()

const gp_Pln & gce_MakePln::Operator

(

)

const

operator gp_Pln()

gce_MakePln::operator gp_Pln

(

)

const

Value()

const gp_Pln & gce_MakePln::Value

(

)

const

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

---

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

• gce_MakePln.hxx