Open CASCADE Technology 6.6.0
Public Member Functions
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:
More...

#include <BRepBuilderAPI_FindPlane.hxx>

Public Member Functions

 BRepBuilderAPI_FindPlane ()
 Initializes an empty algorithm. The function Init is then used to define the shape.

 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:

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:

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.

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.


Detailed Description


Constructor & Destructor Documentation

BRepBuilderAPI_FindPlane::BRepBuilderAPI_FindPlane ( )
BRepBuilderAPI_FindPlane::BRepBuilderAPI_FindPlane ( const TopoDS_Shape S,
const Standard_Real  Tol = -1 
)
  • 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.

Member Function Documentation

Standard_Boolean BRepBuilderAPI_FindPlane::Found ( ) const
void BRepBuilderAPI_FindPlane::Init ( const TopoDS_Shape S,
const Standard_Real  Tol = -1 
)
  • 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.
Handle_Geom_Plane BRepBuilderAPI_FindPlane::Plane ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines