Open CASCADE Technology  6.9.0
Public Member Functions
BRepExtrema_SolutionElem Class Reference

This class is used to store information relative to the minimum distance between two shapes. More...

#include <BRepExtrema_SolutionElem.hxx>

Public Member Functions

 BRepExtrema_SolutionElem ()
 Empty constructor. More...
 
 BRepExtrema_SolutionElem (const Standard_Real theDist, const gp_Pnt &thePoint, const BRepExtrema_SupportType theSolType, const TopoDS_Vertex &theVertex)
 This constructor is used when the solution of a distance is a Vertex. The different initialized fields are: More...
 
 BRepExtrema_SolutionElem (const Standard_Real theDist, const gp_Pnt &thePoint, const BRepExtrema_SupportType theSolType, const TopoDS_Edge &theEdge, const Standard_Real theParam)
 This constructor is used when the solution of distance is on an Edge. The different initialized fields are: More...
 
 BRepExtrema_SolutionElem (const Standard_Real theDist, const gp_Pnt &thePoint, const BRepExtrema_SupportType theSolType, const TopoDS_Face &theFace, const Standard_Real theU, const Standard_Real theV)
 This constructor is used when the solution of distance is in a Face. The different initialized fields are: More...
 
Standard_Real Dist () const
 Returns the value of the minimum distance. More...
 
const gp_PntPoint () const
 Returns the solution point. More...
 
BRepExtrema_SupportType SupportKind () const
 Returns the Support type: IsVertex => The solution is a vertex. IsOnEdge => The solution belongs to an Edge. IsInFace => The solution is inside a Face. More...
 
const TopoDS_VertexVertex () const
 Returns the vertex if the solution is a Vertex. More...
 
const TopoDS_EdgeEdge () const
 Returns the vertex if the solution is an Edge. More...
 
const TopoDS_FaceFace () const
 Returns the vertex if the solution is an Face. More...
 
void EdgeParameter (Standard_Real &theParam) const
 Returns the parameter value if the solution is on Edge. More...
 
void FaceParameter (Standard_Real &theU, Standard_Real &theV) const
 Returns the parameters U and V if the solution is in a Face. More...
 

Detailed Description

This class is used to store information relative to the minimum distance between two shapes.

Constructor & Destructor Documentation

BRepExtrema_SolutionElem::BRepExtrema_SolutionElem ( )
inline

Empty constructor.

BRepExtrema_SolutionElem::BRepExtrema_SolutionElem ( const Standard_Real  theDist,
const gp_Pnt thePoint,
const BRepExtrema_SupportType  theSolType,
const TopoDS_Vertex theVertex 
)
inline

This constructor is used when the solution of a distance is a Vertex. The different initialized fields are:

Parameters
theDistthe distance
thePointthe solution point
theSolTypethe type of solution
theVertexand the Vertex
BRepExtrema_SolutionElem::BRepExtrema_SolutionElem ( const Standard_Real  theDist,
const gp_Pnt thePoint,
const BRepExtrema_SupportType  theSolType,
const TopoDS_Edge theEdge,
const Standard_Real  theParam 
)
inline

This constructor is used when the solution of distance is on an Edge. The different initialized fields are:

Parameters
theDistthe distance
thePointthe solution point
theSolTypethe type of solution
theEdgethe Edge
theParamthe parameter to locate the solution
BRepExtrema_SolutionElem::BRepExtrema_SolutionElem ( const Standard_Real  theDist,
const gp_Pnt thePoint,
const BRepExtrema_SupportType  theSolType,
const TopoDS_Face theFace,
const Standard_Real  theU,
const Standard_Real  theV 
)
inline

This constructor is used when the solution of distance is in a Face. The different initialized fields are:

Parameters
theDistthe distance
thePointthe solution point
theSolTypethe type of solution
theFacethe Face
theUU parameter to locate the solution
theVV parameter to locate the solution

Member Function Documentation

Standard_Real BRepExtrema_SolutionElem::Dist ( ) const
inline

Returns the value of the minimum distance.

const TopoDS_Edge& BRepExtrema_SolutionElem::Edge ( ) const
inline

Returns the vertex if the solution is an Edge.

void BRepExtrema_SolutionElem::EdgeParameter ( Standard_Real theParam) const
inline

Returns the parameter value if the solution is on Edge.

const TopoDS_Face& BRepExtrema_SolutionElem::Face ( ) const
inline

Returns the vertex if the solution is an Face.

void BRepExtrema_SolutionElem::FaceParameter ( Standard_Real theU,
Standard_Real theV 
) const
inline

Returns the parameters U and V if the solution is in a Face.

const gp_Pnt& BRepExtrema_SolutionElem::Point ( ) const
inline

Returns the solution point.

BRepExtrema_SupportType BRepExtrema_SolutionElem::SupportKind ( ) const
inline

Returns the Support type: IsVertex => The solution is a vertex. IsOnEdge => The solution belongs to an Edge. IsInFace => The solution is inside a Face.

const TopoDS_Vertex& BRepExtrema_SolutionElem::Vertex ( ) const
inline

Returns the vertex if the solution is a Vertex.


The documentation for this class was generated from the following file: