GC_MakePlane Class Reference

This class implements the following algorithms used
to create a Plane from gp.
More...

#include <GC_MakePlane.hxx>

Inheritance diagram for GC_MakePlane:

Public Member Functions
	GC_MakePlane (const gp_Ax2 &A2)
	Creates a plane located in 3D space with an axis placement two axis. The "ZDirection" of "A2" is the direction normal to the plane. The "Location" point of "A2" is the origin of the plane. The "XDirection" and "YDirection" of "A2" define the directions of the U isoparametric and V isoparametric curves. More...
	GC_MakePlane (const gp_Pln &Pl)
	Creates a plane from a non persistent plane from package gp. More...
	GC_MakePlane (const gp_Pnt &P, const gp_Dir &V)
	P is the "Location" point or origin of the plane. V is the direction normal to the plane. More...
	GC_MakePlane (const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D)
	Creates a plane from its cartesian equation : Ax + By + Cz + D = 0.0 Status is "BadEquation" if Sqrt (A*A + B*B + C*C) <= Resolution from gp More...
	GC_MakePlane (const gp_Pln &Pln, const gp_Pnt &Point)
	Make a Plane from Geom <ThePlane> parallel to another Pln <Pln> and passing through a Pnt <Point>. More...
	GC_MakePlane (const gp_Pln &Pln, const Standard_Real Dist)
	Make a Plane from Geom <ThePlane> parallel to another Pln <Pln> at the distance <Dist> which can be greater or lower 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>. Otherwize it is in the oposite direction. More...
	GC_MakePlane (const gp_Pnt &P1, const gp_Pnt &P2, const gp_Pnt &P3)
	Make a Plane from Geom <ThePlane> passing through 3 Pnt <P1>,<P2>,<P3>. It returns false if <P1> <P2> <P3> are confused. More...
	GC_MakePlane (const gp_Ax1 &Axis)
	Make a Plane passing through the location of <Axis>and normal to the Direction of <Axis>. More...
const Handle_Geom_Plane &	Value () const
	Returns the constructed plane. <br> Exceptions StdFail_NotDone if no plane is constructed. More...
const Handle_Geom_Plane &	Operator () const
	operator Handle_Geom_Plane () const
Public Member Functions inherited from GC_Root
Standard_Boolean	IsDone () const
	Returns true if the construction is successful. More...
gce_ErrorType	Status () const
	Returns the status of the construction: More...

Additional Inherited Members
Protected Attributes inherited from GC_Root
gce_ErrorType	TheError

Detailed Description

This class implements the following algorithms used
to create a Plane from gp.

• Create a Plane parallel to another and passing
  through a point.
  
• Create a Plane passing through 3 points.
  
• Create a Plane by its normal
  A MakePlane object provides a framework for:
  
• defining the construction of the plane,
  
• implementing the construction algorithm, and
  
• consulting the results. In particular, the Value
  function returns the constructed plane.
  

Constructor & Destructor Documentation

GC_MakePlane::GC_MakePlane

(

const gp_Ax2 &

A2

)

Creates a plane located in 3D space with an axis placement
two axis. The "ZDirection" of "A2" is the direction normal
to the plane. The "Location" point of "A2" is the origin of
the plane. The "XDirection" and "YDirection" of "A2" define
the directions of the U isoparametric and V isoparametric
curves.

GC_MakePlane::GC_MakePlane

(

const gp_Pln &

Pl

)

Creates a plane from a non persistent plane from package gp.

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

P is the "Location" point or origin of the plane.
V is the direction normal to the plane.

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

Creates a plane from its cartesian equation :
Ax + By + Cz + D = 0.0
Status is "BadEquation" if Sqrt (A*A + B*B + C*C)
<= Resolution from gp

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

Make a Plane from Geom <ThePlane> parallel to another
Pln <Pln> and passing through a Pnt <Point>.

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

Make a Plane from Geom <ThePlane> parallel to another
Pln <Pln> at the distance <Dist> which can be greater
or lower 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>.
Otherwize it is in the oposite direction.

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

Make a Plane from Geom <ThePlane> passing through 3
Pnt <P1>,<P2>,<P3>.
It returns false if <P1> <P2> <P3> are confused.

GC_MakePlane::GC_MakePlane

(

const gp_Ax1 &

Axis

)

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

Member Function Documentation

const Handle_Geom_Plane& GC_MakePlane::Operator

(

)

const

GC_MakePlane::operator Handle_Geom_Plane

(

)

const

const Handle_Geom_Plane& GC_MakePlane::Value

(

)

const

 Returns the constructed plane. <br>

Exceptions StdFail_NotDone if no plane is constructed.

---

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

• GC_MakePlane.hxx