Open CASCADE Technology 6.6.0
Public Member Functions
ShapeExtend_WireData Class Reference

This class provides a data structure necessary for work with the wire as with
ordered list of edges, what is required for many algorithms. The advantage of
this class is that it allows to work with wires which are not correct.
The object of the class ShapeExtend_WireData can be initialized by
TopoDS_Wire, and converted back to TopoDS_Wire.
An edge in the wire is defined by its rank number. Operations of accessing,
adding and removing edge at the given rank number are provided. On the whole
wire, operations of circular permutation and reversing (both orientations of
all edges and order of edges) are provided as well.
This class also provides a method to check if the edge in the wire is a seam
(if the wire lies on a face).
This class is handled by reference. Such an approach gives the following advantages:
1. Sharing the object of this class strongly optimizes the processes of
analysis and fixing performed in parallel on the wire stored in the form
of this class. Fixing tool (e.g. ShapeFix_Wire) fixes problems one by
one using analyzing tool (e.g. ShapeAnalysis_Wire). Sharing allows not
to reinitialize each time the analyzing tool with modified
ShapeExtend_WireData what consumes certain time.
2. No copying of contents. The object of ShapeExtend_WireData class has
quite big size, returning it as a result of the function would cause
additional copying of contents if this class were one handled by value.
Moreover, this class is stored as a field in other classes which are
they returned as results of functions, storing only a handle to
ShapeExtend_WireData saves time and memory.

#include <ShapeExtend_WireData.hxx>

Inheritance diagram for ShapeExtend_WireData:
Inheritance graph
[legend]

Public Member Functions

 ShapeExtend_WireData ()
 Empty constructor, creates empty wire with no edges

 ShapeExtend_WireData (const TopoDS_Wire &wire, const Standard_Boolean chained=Standard_True, const Standard_Boolean theManifoldMode=Standard_True)
 Constructor initializing the data from TopoDS_Wire. Calls Init(wire,chained).

void Init (const Handle< ShapeExtend_WireData > &other)
 Copies data from another WireData

Standard_Boolean Init (const TopoDS_Wire &wire, const Standard_Boolean chained=Standard_True, const Standard_Boolean theManifoldMode=Standard_True)
 Loads an already existing wire
If <chained> is True (default), edges are added in the
sequence as they are explored by TopoDS_Iterator
Else, if <chained> is False, wire is explored by
BRepTools_WireExplorer and it is guaranteed that edges will
be sequencially connected.
Remark : In the latter case it can happen that not all edges
will be found (because of limitations of
BRepTools_WireExplorer for disconnected wires and wires
with seam edges).

void Clear ()
 Clears data about Wire.

void ComputeSeams (const Standard_Boolean enforce=Standard_True)
 Computes the list of seam edges
By default (direct call), computing is enforced
For indirect call (from IsSeam) it is redone only if not yet
already done or if the list of edges has changed
Remark : A Seam Edge is an Edge present twice in the list, once as
FORWARD and once as REVERSED
Each sense has its own PCurve, the one for FORWARD
must be set in first

void SetLast (const Standard_Integer num)
 Does a circular permutation in order to set <num>th edge last

void SetDegeneratedLast ()
 When the wire contains at least one degenerated edge, sets it
as last one
Note : It is useful to process pcurves, for instance, while the pcurve
of a DGNR may not be computed from its 3D part (there is none)
it is computed after the other edges have been computed and
chained.

void Add (const TopoDS_Edge &edge, const Standard_Integer atnum=0)
 Adds an edge to a wire, being defined (not yet ended)
This is the plain, basic, function to add an edge
<num> = 0 (D): Appends at end
<num> = 1: Preprends at start
else, Insert before <num>
Remark : Null Edge is simply ignored

void Add (const TopoDS_Wire &wire, const Standard_Integer atnum=0)
 Adds an entire wire, considered as a list of edges
Remark : The wire is assumed to be ordered (TopoDS_Iterator
is used)

void Add (const Handle< ShapeExtend_WireData > &wire, const Standard_Integer atnum=0)
 Adds a wire in the form of WireData

void Add (const TopoDS_Shape &shape, const Standard_Integer atnum=0)
 Adds an edge or a wire invoking corresponding method Add

void AddOriented (const TopoDS_Edge &edge, const Standard_Integer mode)
 Adds an edge to start or end of <me>, according to <mode>
0: at end, as direct
1: at end, as reversed
2: at start, as direct
3: at start, as reversed
< 0: no adding

void AddOriented (const TopoDS_Wire &wire, const Standard_Integer mode)
 Adds a wire to start or end of <me>, according to <mode>
0: at end, as direct
1: at end, as reversed
2: at start, as direct
3: at start, as reversed
< 0: no adding

void AddOriented (const TopoDS_Shape &shape, const Standard_Integer mode)
 Adds an edge or a wire invoking corresponding method
AddOriented

void Remove (const Standard_Integer num=0)
 Removes an Edge, given its rank. By default removes the last edge.

void Set (const TopoDS_Edge &edge, const Standard_Integer num=0)
 Replaces an edge at the given
rank number <num> with new one. Default is last edge (<num> = 0).

void Reverse ()
 Reverses the sense of the list and the orientation of each Edge
This method should be called when either wire has no seam edges
or face is not available

void Reverse (const TopoDS_Face &face)
 Reverses the sense of the list and the orientation of each Edge
The face is necessary for swapping pcurves for seam edges
(first pcurve corresponds to orientation FORWARD, and second to
REVERSED; when edge is reversed, pcurves must be swapped)
If face is NULL, no swapping is performed

Standard_Integer NbEdges () const
 Returns the count of currently recorded edges

Standard_Integer NbNonManifoldEdges () const
 Returns the count of currently recorded non-manifold edges

TopoDS_Edge NonmanifoldEdge (const Standard_Integer num) const
 Returns <num>th nonmanifold Edge

Handle_TopTools_HSequenceOfShape NonmanifoldEdges () const
 Returns sequence of non-manifold edges
This sequence can be not empty if wire data set in manifold mode but
initial wire has INTERNAL orientation or contains INTERNAL edges


Standard_BooleanManifoldMode ()
 Returns mode defining manifold wire data or not.
If manifold that nonmanifold edges will not be not
consider during operations(previous behaviour)
and they will be added only in result wire
else non-manifold edges will consider during operations

TopoDS_Edge Edge (const Standard_Integer num) const
 Returns <num>th Edge

Standard_Integer Index (const TopoDS_Edge &edge)
 Returns the index of the edge
If the edge is a seam the orientation is also checked
Returns 0 if the edge is not found in the list

Standard_Boolean IsSeam (const Standard_Integer num)
 Tells if an Edge is seam (see ComputeSeams)
An edge is considered as seam if it presents twice in
the edge list, once as FORWARD and once as REVERSED.

TopoDS_Wire Wire () const
 Makes TopoDS_Wire using
BRep_Builder (just creates the TopoDS_Wire object and adds
all edges into it). This method should be called when
the wire is correct (for example, after successful
fixes by ShapeFix_Wire) and adjacent edges share common
vertices. In case if adjacent edges do not share the same
vertices the resulting TopoDS_Wire will be invalid.

TopoDS_Wire WireAPIMake () const
 Makes TopoDS_Wire using
BRepAPI_MakeWire. Class BRepAPI_MakeWire merges
geometrically coincided vertices and can disturb
correct order of edges in the wire. If this class fails,
null shape is returned.


Constructor & Destructor Documentation

ShapeExtend_WireData::ShapeExtend_WireData ( )
ShapeExtend_WireData::ShapeExtend_WireData ( const TopoDS_Wire wire,
const Standard_Boolean  chained = Standard_True,
const Standard_Boolean  theManifoldMode = Standard_True 
)

Member Function Documentation

void ShapeExtend_WireData::Add ( const TopoDS_Edge edge,
const Standard_Integer  atnum = 0 
)
void ShapeExtend_WireData::Add ( const TopoDS_Wire wire,
const Standard_Integer  atnum = 0 
)
void ShapeExtend_WireData::Add ( const Handle< ShapeExtend_WireData > &  wire,
const Standard_Integer  atnum = 0 
)
void ShapeExtend_WireData::Add ( const TopoDS_Shape shape,
const Standard_Integer  atnum = 0 
)
void ShapeExtend_WireData::AddOriented ( const TopoDS_Edge edge,
const Standard_Integer  mode 
)
void ShapeExtend_WireData::AddOriented ( const TopoDS_Wire wire,
const Standard_Integer  mode 
)
void ShapeExtend_WireData::AddOriented ( const TopoDS_Shape shape,
const Standard_Integer  mode 
)
void ShapeExtend_WireData::Clear ( )
void ShapeExtend_WireData::ComputeSeams ( const Standard_Boolean  enforce = Standard_True)
TopoDS_Edge ShapeExtend_WireData::Edge ( const Standard_Integer  num) const
Standard_Integer ShapeExtend_WireData::Index ( const TopoDS_Edge edge)
Standard_Boolean ShapeExtend_WireData::Init ( const TopoDS_Wire wire,
const Standard_Boolean  chained = Standard_True,
const Standard_Boolean  theManifoldMode = Standard_True 
)
void ShapeExtend_WireData::Init ( const Handle< ShapeExtend_WireData > &  other)
Standard_Boolean ShapeExtend_WireData::IsSeam ( const Standard_Integer  num)
Standard_Boolean& ShapeExtend_WireData::ManifoldMode ( )
Standard_Integer ShapeExtend_WireData::NbEdges ( ) const
Standard_Integer ShapeExtend_WireData::NbNonManifoldEdges ( ) const
TopoDS_Edge ShapeExtend_WireData::NonmanifoldEdge ( const Standard_Integer  num) const
Handle_TopTools_HSequenceOfShape ShapeExtend_WireData::NonmanifoldEdges ( ) const
void ShapeExtend_WireData::Remove ( const Standard_Integer  num = 0)
void ShapeExtend_WireData::Reverse ( )
void ShapeExtend_WireData::Reverse ( const TopoDS_Face face)
void ShapeExtend_WireData::Set ( const TopoDS_Edge edge,
const Standard_Integer  num = 0 
)
void ShapeExtend_WireData::SetDegeneratedLast ( )
void ShapeExtend_WireData::SetLast ( const Standard_Integer  num)
TopoDS_Wire ShapeExtend_WireData::Wire ( ) const
TopoDS_Wire ShapeExtend_WireData::WireAPIMake ( ) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines