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 ()

	BRepExtrema_SolutionElem (const Standard_Real d, const gp_Pnt &Pt, const BRepExtrema_SupportType SolType, const TopoDS_Vertex &vertex)
	initialisation of the fields This constructor is used when the solution of a distance is a Vertex. The different initialized fields are: _ the distance d _ the solution point _ the type of solution _ and the Vertex. More...

	BRepExtrema_SolutionElem (const Standard_Real d, const gp_Pnt &Pt, const BRepExtrema_SupportType SolType, const TopoDS_Edge &edge, const Standard_Real t)
	initialisation of the fiels. This constructor is used when the solution of distance is on an Edge. The different initialized fields are: _ the distance d, _ the solution point, _ the type of solution, _ the Edge, _ and the parameter t to locate the solution. More...

	BRepExtrema_SolutionElem (const Standard_Real d, const gp_Pnt &Pt, const BRepExtrema_SupportType SolType, const TopoDS_Face &face, const Standard_Real u, const Standard_Real v)
	initialisation of the fields This constructor is used when the solution of distance is in a Face. The different initialized fields are: _ the distance d, _ the solution point, _ the type of solution, _ the Face, _ and the parameter u et v to locate the solution. More...

Standard_Real	Dist () const
	returns the value of the minimum distance. More...

const gp_Pnt &	Point () 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_Vertex &	Vertex () const
	returns the vertex if the solution is a Vertex. More...

const TopoDS_Edge &	Edge () const
	returns the vertex if the solution is an Edge. More...

const TopoDS_Face &	Face () const
	returns the vertex if the solution is an Face. More...

void	EdgeParameter (Standard_Real &par1) const
	returns the parameter t if the solution is on Edge. More...

void	FaceParameter (Standard_Real &par1, Standard_Real &par2) const
	returns the parameters u et 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

BRepExtrema_SolutionElem::BRepExtrema_SolutionElem	(	const Standard_Real	d,
		const gp_Pnt &	Pt,
		const BRepExtrema_SupportType	SolType,
		const TopoDS_Vertex &	vertex
	)

inline

initialisation of the fields
This constructor is used when the solution of a distance is a Vertex.
The different initialized fields are:
_ the distance d
_ the solution point
_ the type of solution
_ and the Vertex.

BRepExtrema_SolutionElem::BRepExtrema_SolutionElem	(	const Standard_Real	d,
		const gp_Pnt &	Pt,
		const BRepExtrema_SupportType	SolType,
		const TopoDS_Edge &	edge,
		const Standard_Real	t
	)

inline

initialisation of the fiels.
This constructor is used when the solution of distance is on an Edge.
The different initialized fields are:
_ the distance d,
_ the solution point,
_ the type of solution,
_ the Edge,
_ and the parameter t to locate the solution.

BRepExtrema_SolutionElem::BRepExtrema_SolutionElem	(	const Standard_Real	d,
		const gp_Pnt &	Pt,
		const BRepExtrema_SupportType	SolType,
		const TopoDS_Face &	face,
		const Standard_Real	u,
		const Standard_Real	v
	)

inline

initialisation of the fields
This constructor is used when the solution of distance is in
a Face. The different initialized fields are:
_ the distance d,
_ the solution point,
_ the type of solution,
_ the Face,
_ and the parameter u et v 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 & par1 ) const

inline

returns the parameter t 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 &	par1,
		Standard_Real &	par2
	)		const

inline

returns the parameters u et 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:

BRepExtrema_SolutionElem.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation