GC_MakePlane Class Reference

Implements construction algorithms for planes in 3D space. Supported constructions include: More...

#include <GC_MakePlane.hxx>

Inheritance diagram for GC_MakePlane:

Public Member Functions
	GC_MakePlane (const gp_Pln &thePl)
	Creates a plane from a non-persistent plane from package gp.
	GC_MakePlane (const gp_Pnt &theP, const gp_Dir &theV)
	Creates a plane from point and normal direction.
	GC_MakePlane (const double theA, const double theB, const double theC, const double theD)
	Creates a plane from its cartesian equation: A * x + B * y + C * z + D = 0.0.
	GC_MakePlane (const gp_Pln &thePln, const gp_Pnt &thePoint)
	Creates a plane parallel to the input plane and passing through the input point.
	GC_MakePlane (const gp_Pln &thePln, const double theDist)
	Creates a plane parallel to the input plane at signed distance.
	GC_MakePlane (const gp_Pnt &theP1, const gp_Pnt &theP2, const gp_Pnt &theP3)
	Creates a plane passing through three points.
	GC_MakePlane (const gp_Ax1 &theAxis)
	Creates a plane through axis location and normal to axis direction.
const occ::handle< Geom_Plane > &	Value () const
	Returns the constructed plane. Exceptions StdFail_NotDone if no plane is constructed.
	operator const occ::handle< Geom_Plane > & () const
	Conversion operator returning the constructed object.
Public Member Functions inherited from GC_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 GC_Root
gce_ErrorType	TheError

Detailed Description

Implements construction algorithms for planes in 3D space. Supported constructions include:

• a plane parallel to another plane and passing through a point;
• a plane passing through three points;
• a plane defined by a point and normal direction. 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() [1/7]

GC_MakePlane::GC_MakePlane

(

const gp_Pln &

thePl

)

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

Parameters

[in]

thePl

source plane

GC_MakePlane() [2/7]

GC_MakePlane::GC_MakePlane	(	const gp_Pnt &	theP,
		const gp_Dir &	theV )

Creates a plane from point and normal direction.

Parameters

[in]	theP	location point of the plane
[in]	theV	normal direction

GC_MakePlane() [3/7]

GC_MakePlane::GC_MakePlane	(	const double	theA,
		const double	theB,
		const double	theC,
		const double	theD )

Creates a plane from its cartesian equation: A * x + B * y + C * z + D = 0.0.

Parameters

[in]	theA	equation coefficient A
[in]	theB	equation coefficient B
[in]	theC	equation coefficient C
[in]	theD	equation coefficient D

Note

Status is gce_BadEquation if sqrt(theA*theA + theB*theB + theC*theC) is below gp resolution.

GC_MakePlane() [4/7]

GC_MakePlane::GC_MakePlane	(	const gp_Pln &	thePln,
		const gp_Pnt &	thePoint )

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

Parameters

[in]	thePln	source plane
[in]	thePoint	point on resulting plane

GC_MakePlane() [5/7]

GC_MakePlane::GC_MakePlane	(	const gp_Pln &	thePln,
		const double	theDist )

Creates a plane parallel to the input plane at signed distance.

Parameters

[in]	thePln	source plane
[in]	theDist	signed distance

Note

Positive distance follows the normal of the input plane.

GC_MakePlane() [6/7]

GC_MakePlane::GC_MakePlane	(	const gp_Pnt &	theP1,
		const gp_Pnt &	theP2,
		const gp_Pnt &	theP3 )

Creates a plane passing through three points.

Parameters

[in]	theP1	first point
[in]	theP2	second point
[in]	theP3	third point

Note

Construction fails when points are confused/collinear.

GC_MakePlane() [7/7]

GC_MakePlane::GC_MakePlane

(

const gp_Ax1 &

theAxis

)

Creates a plane through axis location and normal to axis direction.

Parameters

[in]

theAxis

axis defining location and normal

Member Function Documentation

operator const occ::handle< Geom_Plane > &()

GC_MakePlane::operator const occ::handle< Geom_Plane > & ( ) const

inline

Conversion operator returning the constructed object.

Returns

resulting object

Value()

const occ::handle< Geom_Plane > & GC_MakePlane::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:

• GC_MakePlane.hxx