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.
	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:
	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:
	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:
Standard_Real	Dist () const
	Returns the value of the minimum distance.
const gp_Pnt &	Point () const
	Returns the solution point.
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.
const TopoDS_Vertex &	Vertex () const
	Returns the vertex if the solution is a Vertex.
const TopoDS_Edge &	Edge () const
	Returns the vertex if the solution is an Edge.
const TopoDS_Face &	Face () const
	Returns the vertex if the solution is an Face.
void	EdgeParameter (Standard_Real &theParam) const
	Returns the parameter value if the solution is on Edge.
void	FaceParameter (Standard_Real &theU, Standard_Real &theV) const
	Returns the parameters U and V if the solution is in a Face.

Detailed Description

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

Constructor & Destructor Documentation

BRepExtrema_SolutionElem() [1/4]

BRepExtrema_SolutionElem::BRepExtrema_SolutionElem ( )

inline

Empty constructor.

BRepExtrema_SolutionElem() [2/4]

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

theDist	the distance
thePoint	the solution point
theSolType	the type of solution
theVertex	and the Vertex

BRepExtrema_SolutionElem() [3/4]

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

theDist	the distance
thePoint	the solution point
theSolType	the type of solution
theEdge	the Edge
theParam	the parameter to locate the solution

BRepExtrema_SolutionElem() [4/4]

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

theDist	the distance
thePoint	the solution point
theSolType	the type of solution
theFace	the Face
theU	U parameter to locate the solution
theV	V parameter to locate the solution

Member Function Documentation

Dist()

Standard_Real BRepExtrema_SolutionElem::Dist ( ) const

inline

Returns the value of the minimum distance.

Edge()

const TopoDS_Edge & BRepExtrema_SolutionElem::Edge ( ) const

inline

Returns the vertex if the solution is an Edge.

EdgeParameter()

void BRepExtrema_SolutionElem::EdgeParameter ( Standard_Real & theParam ) const

inline

Returns the parameter value if the solution is on Edge.

Face()

const TopoDS_Face & BRepExtrema_SolutionElem::Face ( ) const

inline

Returns the vertex if the solution is an Face.

FaceParameter()

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.

Point()

const gp_Pnt & BRepExtrema_SolutionElem::Point ( ) const

inline

Returns the solution point.

SupportKind()

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.

Vertex()

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:

• BRepExtrema_SolutionElem.hxx