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

ModelingAlgorithms
TKTopAlgo
BRepBuilderAPI


BRepBuilderAPI_FindPlane Class Reference

Describes functions to find the plane in which the edges
of a given shape are located.
A FindPlane object provides a framework for:
- extracting the edges of a given shape,
- implementing the construction algorithm, and
- consulting the result.
.

#include <BRepBuilderAPI_FindPlane.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT BRepBuilderAPI_FindPlane ()
 Initializes an empty algorithm. The function Init is then used to define the shape.
.
Standard_EXPORT BRepBuilderAPI_FindPlane (const TopoDS_Shape &S, const Standard_Real Tol=-1)
 Constructs the plane containing the edges of the shape S.
A plane is built only if all the edges are within a distance
of less than or equal to tolerance from a planar surface.
This tolerance value is equal to the larger of the following two values:
- Tol, where the default value is negative, or
- the largest of the tolerance values assigned to the individual edges of S.
Use the function Found to verify that a plane is built.
The resulting plane is then retrieved using the function Plane.
.
Standard_EXPORT void Init (const TopoDS_Shape &S, const Standard_Real Tol=-1)
 Constructs the plane containing the edges of the shape S.
A plane is built only if all the edges are within a distance
of less than or equal to tolerance from a planar surface.
This tolerance value is equal to the larger of the following two values:
- Tol, where the default value is negative, or
- the largest of the tolerance values assigned to the individual edges of S.
Use the function Found to verify that a plane is built.
The resulting plane is then retrieved using the function Plane.
.
Standard_EXPORT Standard_Boolean Found () const
 Returns true if a plane containing the edges of the
shape is found and built. Use the function Plane to consult the result.
.
Standard_EXPORT Handle_Geom_Plane Plane () const
 Returns the plane containing the edges of the shape.
Warning
Use the function Found to verify that the plane is built. If
a plane is not found, Plane returns a null handle.
.

Private Attributes

Handle_Geom_Plane myPlane


Constructor & Destructor Documentation

Standard_EXPORT BRepBuilderAPI_FindPlane::BRepBuilderAPI_FindPlane  ) 
 

Standard_EXPORT BRepBuilderAPI_FindPlane::BRepBuilderAPI_FindPlane const TopoDS_Shape &  S,
const Standard_Real  Tol = -1
 


Member Function Documentation

Standard_EXPORT Standard_Boolean BRepBuilderAPI_FindPlane::Found  )  const
 

Standard_EXPORT void BRepBuilderAPI_FindPlane::Init const TopoDS_Shape &  S,
const Standard_Real  Tol = -1
 

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

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

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

Standard_EXPORT Handle_Geom_Plane BRepBuilderAPI_FindPlane::Plane  )  const
 


Field Documentation

Handle_Geom_Plane BRepBuilderAPI_FindPlane::myPlane [private]
 


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