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

ModelingData
TKG2d
GProp


GProp_PEquation Class Reference

A framework to analyze a collection - or cloud
- of points and to verify if they are coincident,
collinear or coplanar within a given precision. If
so, it also computes the mean point, the mean
line or the mean plane of the points. If not, it
computes the minimal box which includes all the points.
.

#include <GProp_PEquation.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT GProp_PEquation (const TColgp_Array1OfPnt &Pnts, const Standard_Real Tol)
 Constructs a framework to analyze the
collection of points Pnts and computes:
- the mean point if the points in question are
considered to be coincident within the precision Tol, or
- the mean line if they are considered to be
collinear within the precision Tol, or
- the mean plane if they are considered to be
coplanar within the precision Tol, or
- the minimal box which contains all the points. Use :
- the functions IsPoint, IsLinear, IsPlanar
and IsSpace to find the result of the analysis, and
- the function Point, Line, Plane or Box to
access the computed result.
.
Standard_EXPORT Standard_Boolean IsPlanar () const
 Returns true if, according to the given
tolerance, the points analyzed by this framework are coplanar.
Use the function Plane to access the computed result.
.
Standard_EXPORT Standard_Boolean IsLinear () const
 Returns true if, according to the given
tolerance, the points analyzed by this framework are colinear.
Use the function Line to access the computed result.
.
Standard_EXPORT Standard_Boolean IsPoint () const
 Returns true if, according to the given
tolerance, the points analyzed by this framework are coincident.
Use the function Point to access the computed result.
.
Standard_EXPORT Standard_Boolean IsSpace () const
 Returns true if, according to the given
tolerance value, the points analyzed by this
framework are neither coincident, nor collinear, nor coplanar.
Use the function Box to query the smallest box
that includes the collection of points.
.
Standard_EXPORT gp_Pln Plane () const
 Returns the mean plane passing near all the
points analyzed by this framework if, according
to the given precision, the points are considered to be coplanar.
Exceptions
Standard_NoSuchObject if, according to the
given precision value, the points analyzed by
this framework are considered to be:
- coincident, or
- collinear, or
- not coplanar.
.
Standard_EXPORT gp_Lin Line () const
 Returns the mean line passing near all the
points analyzed by this framework if, according
to the given precision value, the points are considered to be collinear.
Exceptions
Standard_NoSuchObject if, according to the
given precision, the points analyzed by this
framework are considered to be:
- coincident, or
- not collinear.
.
Standard_EXPORT gp_Pnt Point () const
 Returns the mean point of all the points
analyzed by this framework if, according to the
given precision, the points are considered to be coincident.
Exceptions
Standard_NoSuchObject if, according to the
given precision, the points analyzed by this
framework are not considered to be coincident.
.
Standard_EXPORT void Box (gp_Pnt &P, gp_Vec &V1, gp_Vec &V2, gp_Vec &V3) const
 Returns the definition of the smallest box which
contains all the points analyzed by this
framework if, according to the given precision
value, the points are considered to be neither
coincident, nor collinear and nor coplanar.
This box is centered on the barycenter P of the
collection of points. Its sides are parallel to the
three vectors V1, V2 and V3, the length of
which is the length of the box in the corresponding direction.
Note: Vectors V1, V2 and V3 are parallel to
the three axes of principal inertia of the system
composed of the collection of points where each point is of equal mass.
Exceptions
Standard_NoSuchObject if, according to the given precision,
the points analyzed by this framework are considered to be coincident, collinear or coplanar.
.

Private Attributes

GProp_EquaType type
gp_Pnt g
gp_Vec v1
gp_Vec v2
gp_Vec v3


Constructor & Destructor Documentation

Standard_EXPORT GProp_PEquation::GProp_PEquation const TColgp_Array1OfPnt &  Pnts,
const Standard_Real  Tol
 


Member Function Documentation

Standard_EXPORT void GProp_PEquation::Box gp_Pnt &  P,
gp_Vec &  V1,
gp_Vec &  V2,
gp_Vec &  V3
const
 

Standard_EXPORT Standard_Boolean GProp_PEquation::IsLinear  )  const
 

Standard_EXPORT Standard_Boolean GProp_PEquation::IsPlanar  )  const
 

Standard_EXPORT Standard_Boolean GProp_PEquation::IsPoint  )  const
 

Standard_EXPORT Standard_Boolean GProp_PEquation::IsSpace  )  const
 

Standard_EXPORT gp_Lin GProp_PEquation::Line  )  const
 

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

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

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

Standard_EXPORT gp_Pln GProp_PEquation::Plane  )  const
 

Standard_EXPORT gp_Pnt GProp_PEquation::Point  )  const
 


Field Documentation

gp_Pnt GProp_PEquation::g [private]
 

GProp_EquaType GProp_PEquation::type [private]
 

gp_Vec GProp_PEquation::v1 [private]
 

gp_Vec GProp_PEquation::v2 [private]
 

gp_Vec GProp_PEquation::v3 [private]
 


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