OCC Main Page | ModelingData | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingData
TKGeomBase
gce


gce_MakePln Class Reference

This class implements the following algorithms used
to create a Pln 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") .
.

#include <gce_MakePln.hxx>

Inheritance diagram for gce_MakePln:

Inheritance graph
[legend]

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT 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.
.
Standard_EXPORT gce_MakePln (const gp_Pnt &P, const gp_Dir &V)
 Creates a plane with the "Location" point


and the normal direction <v>.
.

Standard_EXPORT 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.
.
Standard_EXPORT 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>.
.
Standard_EXPORT 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>.
Otherwize it is in the opposite direction.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT const gp_Pln & Value () const
 Returns the constructed plane.
Exceptions StdFail_NotDone if no plane is constructed.
.
Standard_EXPORT const gp_Pln & Operator () const
Standard_EXPORT operator gp_Pln () const

Private Attributes

gp_Pln ThePln

Constructor & Destructor Documentation

Standard_EXPORT gce_MakePln::gce_MakePln const gp_Ax2 &  A2  ) 
 

Standard_EXPORT gce_MakePln::gce_MakePln const gp_Pnt &  P,
const gp_Dir &  V
 

Standard_EXPORT gce_MakePln::gce_MakePln const Standard_Real  A,
const Standard_Real  B,
const Standard_Real  C,
const Standard_Real  D
 

Standard_EXPORT gce_MakePln::gce_MakePln const gp_Pln &  Pln,
const gp_Pnt &  Point
 

Standard_EXPORT gce_MakePln::gce_MakePln const gp_Pln &  Pln,
const Standard_Real  Dist
 

Standard_EXPORT gce_MakePln::gce_MakePln const gp_Pnt &  P1,
const gp_Pnt &  P2,
const gp_Pnt &  P3
 

Standard_EXPORT gce_MakePln::gce_MakePln const gp_Pnt &  P1,
const gp_Pnt &  P2
 

Standard_EXPORT gce_MakePln::gce_MakePln const gp_Ax1 &  Axis  ) 
 


Member Function Documentation

Standard_EXPORT const gp_Pln& gce_MakePln::Operator  )  const
 

void gce_MakePln::operator delete void *  anAddress  )  [inline]
 

Reimplemented from gce_Root.

Standard_EXPORT gce_MakePln::operator gp_Pln  )  const
 

void* gce_MakePln::operator new size_t  size  )  [inline]
 

Reimplemented from gce_Root.

void* gce_MakePln::operator new size_t  ,
void *  anAddress
[inline]
 

Reimplemented from gce_Root.

Standard_EXPORT const gp_Pln& gce_MakePln::Value  )  const
 


Field Documentation

gp_Pln gce_MakePln::ThePln [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:22:45 2008 for OpenCASCADE by  doxygen 1.4.1