Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
ShapeAnalysis_WireOrder Class Reference

This class is intended to control and, if possible, redefine
the order of a list of edges which define a wire
Edges are not given directly, but as their bounds (start,end)

This allows to use this tool, either on existing wire, or on
data just taken from a file (coordinates are easy to get)

It can work, either in 2D, or in 3D, but not miscible
Warning about tolerance : according to the mode (2D/3D), it
must be given as 2D or 3D (i.e. metric) tolerance, uniform
on the whole list

Two phases : firstly add the couples (start,end)
secondly perform then get the result

#include <ShapeAnalysis_WireOrder.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC ShapeAnalysis_WireOrder ()
 Empty constructor

 ShapeAnalysis_WireOrder (const Standard_Boolean mode3d, const Standard_Real tol)
 Creates a WireOrder in 3D (if mode3d is True) or 2D (if False)
with a tolerance

void SetMode (const Standard_Boolean mode3d, const Standard_Real tol)
 Sets new values. Clears the connexion list
If <mode3d> changes, also clears the edge list (else, doesnt)

Standard_Real Tolerance () const
 Returns the working tolerance

void Clear ()
 Clears the list of edges, but not mode and tol

void Add (const gp_XYZ &start3d, const gp_XYZ &end3d)
 Adds a couple of points 3D (start,end)

void Add (const gp_XY &start2d, const gp_XY &end2d)
 Adds a couple of points 2D (start,end)

Standard_Integer NbEdges () const
 Returns the count of added couples of points (one per edges)

Standard_BooleanKeepLoopsMode ()
 If this mode is True method perform does not sort edges of
different loops. The resulting order is first loop, second
one etc...

void Perform (const Standard_Boolean closed=Standard_True)
 Computes the better order
If <closed> is True (D) considers also closure
Optimised if the couples were already in order
The criterium is : two couples in order if distance between
end-prec and start-cur is less then starting tolerance <tol>
Else, the smallest distance is reached
Gap corresponds to a smallest distance greater than <tol>

Standard_Boolean IsDone () const
 Tells if Perform has been done
Else, the following methods returns original values

Standard_Integer Status () const
 Returns the status of the order (0 if not done) :
0 : all edges are direct and in sequence
1 : all edges are direct but some are not in sequence
2 : in addition, unresolved gaps remain
-1 : some edges are reversed, but no gap remain
-2 : some edges are reversed and some gaps remain
-10 : COULD NOT BE RESOLVED, Failure on Reorder
gap : regarding starting <tol>

Standard_Integer Ordered (const Standard_Integer n) const
 Returns the number of original edge which correspond to the
newly ordered number <n>
Warning : the returned value is NEGATIVE if edge should be reversed

void XYZ (const Standard_Integer num, gp_XYZ &start3d, gp_XYZ &end3d) const
 Returns the values of the couple <num>, as 3D values

void XY (const Standard_Integer num, gp_XY &start2d, gp_XY &end2d) const
 Returns the values of the couple <num>, as 2D values

Standard_Real Gap (const Standard_Integer num=0) const
 Returns the gap between a couple and its preceeding
<num> is considered ordered
If <num> = 0 (D), returns the greatest gap found

void SetChains (const Standard_Real gap)
 Determines the chains inside which successive edges have a gap
less than a given value. Queried by NbChains and Chain

Standard_Integer NbChains () const
 Returns the count of computed chains

void Chain (const Standard_Integer num, Standard_Integer &n1, Standard_Integer &n2) const
 Returns, for the chain n0 num, starting and ending numbers of
edges. In the list of ordered edges (see Ordered for originals)

void SetCouples (const Standard_Real gap)
 Determines the couples of edges for which end and start fit
inside a given gap. Queried by NbCouples and Couple

Standard_Integer NbCouples () const
 Returns the count of computed couples

void Couple (const Standard_Integer num, Standard_Integer &n1, Standard_Integer &n2) const
 Returns, for the couple n0 num, the two implied edges
In the list of ordered edges


Constructor & Destructor Documentation


Member Function Documentation

void ShapeAnalysis_WireOrder::Add ( const gp_XYZ start3d,
const gp_XYZ end3d 
)
void ShapeAnalysis_WireOrder::Add ( const gp_XY start2d,
const gp_XY end2d 
)
void ShapeAnalysis_WireOrder::XY ( const Standard_Integer  num,
gp_XY start2d,
gp_XY end2d 
) const
void ShapeAnalysis_WireOrder::XYZ ( const Standard_Integer  num,
gp_XYZ start3d,
gp_XYZ end3d 
) const

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