BRepExtrema_DistShapeShape Class Reference

This class provides tools to compute minimum distance
between two Shapes (Compound,CompSolid, Solid, Shell, Face, Wire, Edge, Vertex).

#include <BRepExtrema_DistShapeShape.hxx>

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
 BRepExtrema_DistShapeShape ()
 create empty brepextrema

 BRepExtrema_DistShapeShape (const TopoDS_Shape &Shape1, const TopoDS_Shape &Shape2)
 computation of the minimum distance (value and
couple of points) using default deflection

 BRepExtrema_DistShapeShape (const TopoDS_Shape &Shape1, const TopoDS_Shape &Shape2, const Standard_Real theDeflection)
 Creates brepextrema and load both shapes into it
Default value is Precision::Confusion().

void SetDeflection (const Standard_Real theDeflection)
void LoadS1 (const TopoDS_Shape &Shape1)
 load first shape into extrema

void LoadS2 (const TopoDS_Shape &Shape1)
 load second shape into extrema

Standard_Boolean Perform ()
 computation of the minimum distance (value and
couple of points). Parameter theDeflection is used
to specify a maximum deviation of extreme distances
from the minimum one.
Returns IsDone status.

Standard_Boolean IsDone () const
 True if the minimum distance is found.

Standard_Integer NbSolution () const
 Returns the number of solutions satisfying the minimum
distance.

Standard_Real Value () const
 Returns the value of the minimum distance.

Standard_Boolean InnerSolution () const
 True if one of the shapes is a solid and the
other shape is completely or partially inside the solid.

gp_Pnt PointOnShape1 (const Standard_Integer N) const
 Returns the Point corresponding to the <N>th
solution on the first Shape

gp_Pnt PointOnShape2 (const Standard_Integer N) const
 Returns the Point corresponding to the <N>th
solution on the second Shape

BRepExtrema_SupportType SupportTypeShape1 (const Standard_Integer N) const
 gives the type of the support where the Nth
solution on the first shape is situated:
IsVertex :
=> the Nth solution on the first shape is a Vertex
IsOnEdge
=> the Nth soluion on the first shape is on a Edge
IsInFace
=> the Nth solution on the first shape is inside a
face

the corresponding support is obtained by the
method SupportOnShape1

BRepExtrema_SupportType SupportTypeShape2 (const Standard_Integer N) const
 gives the type of the support where the Nth
solution on the second shape is situated:
IsVertex :
=> the Nth solution on the second shape is a Vertex
IsOnEdge
=> the Nth soluion on the secondt shape is on a Edge
IsInFace
=> the Nth solution on the second shape is inside a
face

the support is obtained by the method SupportOnShape2

TopoDS_Shape SupportOnShape1 (const Standard_Integer N) const
 gives the support where the Nth
solution on the first shape is situated.
This support can be a Vertex, an Edge or a Face.

TopoDS_Shape SupportOnShape2 (const Standard_Integer N) const
 gives the support where the Nth
solution on the second shape is situated.
This support can be a Vertex, an Edge or a Face.

void ParOnEdgeS1 (const Standard_Integer N, Standard_Real &t) const
 gives the corresponding parameter t if the Nth
Solution is situated on an Egde of the first shape

void ParOnEdgeS2 (const Standard_Integer N, Standard_Real &t) const
 gives the corresponding parameter t if the Nth
Solution is situated on an Egde of the first shape

void ParOnFaceS1 (const Standard_Integer N, Standard_Real &u, Standard_Real &v) const
 gives the corresponding parameters (U,V) if the Nth
Solution is situated on an face of the first shape

void ParOnFaceS2 (const Standard_Integer N, Standard_Real &u, Standard_Real &v) const
 gives the corresponding parameters (U,V) if the Nth
Solution is situated on an Face of the second shape

void Dump (Standard_OStream &o) const
 Prints on the stream o information on the current state
of the object.



Constructor & Destructor Documentation

BRepExtrema_DistShapeShape::BRepExtrema_DistShapeShape (  ) 
BRepExtrema_DistShapeShape::BRepExtrema_DistShapeShape ( const TopoDS_Shape Shape1,
const TopoDS_Shape Shape2 
)
BRepExtrema_DistShapeShape::BRepExtrema_DistShapeShape ( const TopoDS_Shape Shape1,
const TopoDS_Shape Shape2,
const Standard_Real  theDeflection 
)

Member Function Documentation

void BRepExtrema_DistShapeShape::Dump ( Standard_OStream o  )  const
Standard_Boolean BRepExtrema_DistShapeShape::InnerSolution (  )  const
Standard_Boolean BRepExtrema_DistShapeShape::IsDone (  )  const
void BRepExtrema_DistShapeShape::LoadS1 ( const TopoDS_Shape Shape1  ) 
void BRepExtrema_DistShapeShape::LoadS2 ( const TopoDS_Shape Shape1  ) 
Standard_Integer BRepExtrema_DistShapeShape::NbSolution (  )  const
void BRepExtrema_DistShapeShape::operator delete ( void *  anAddress  )  [inline]
void* BRepExtrema_DistShapeShape::operator new ( size_t  size  )  [inline]
void* BRepExtrema_DistShapeShape::operator new ( size_t  ,
void *  anAddress 
) [inline]
void BRepExtrema_DistShapeShape::ParOnEdgeS1 ( const Standard_Integer  N,
Standard_Real t 
) const
void BRepExtrema_DistShapeShape::ParOnEdgeS2 ( const Standard_Integer  N,
Standard_Real t 
) const
void BRepExtrema_DistShapeShape::ParOnFaceS1 ( const Standard_Integer  N,
Standard_Real u,
Standard_Real v 
) const
void BRepExtrema_DistShapeShape::ParOnFaceS2 ( const Standard_Integer  N,
Standard_Real u,
Standard_Real v 
) const
Standard_Boolean BRepExtrema_DistShapeShape::Perform (  ) 
gp_Pnt BRepExtrema_DistShapeShape::PointOnShape1 ( const Standard_Integer  N  )  const
gp_Pnt BRepExtrema_DistShapeShape::PointOnShape2 ( const Standard_Integer  N  )  const
void BRepExtrema_DistShapeShape::SetDeflection ( const Standard_Real  theDeflection  ) 
TopoDS_Shape BRepExtrema_DistShapeShape::SupportOnShape1 ( const Standard_Integer  N  )  const
TopoDS_Shape BRepExtrema_DistShapeShape::SupportOnShape2 ( const Standard_Integer  N  )  const
BRepExtrema_SupportType BRepExtrema_DistShapeShape::SupportTypeShape1 ( const Standard_Integer  N  )  const
BRepExtrema_SupportType BRepExtrema_DistShapeShape::SupportTypeShape2 ( const Standard_Integer  N  )  const
Standard_Real BRepExtrema_DistShapeShape::Value (  )  const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Mar 3 10:52:48 2011 for Open CASCADE Technology by  doxygen 1.6.3