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

Describes functions to build wires from edges. A wire can
be built from any number of edges.
To build a wire you first initialize the construction, then
add edges in sequence. An unlimited number of edges
can be added. The initialization of construction is done with:
More...

#include <BRepBuilderAPI_MakeWire.hxx>

Inheritance diagram for BRepBuilderAPI_MakeWire:
Inheritance graph
[legend]

Public Member Functions

DEFINE_STANDARD_ALLOC BRepBuilderAPI_MakeWire ()
 Constructs an empty wire framework, to which edges
are added using the Add function.
As soon as the wire contains one edge, it can return
with the use of the function Wire.
Warning
The function Error will return
BRepBuilderAPI_EmptyWire if it is called before at
least one edge is added to the wire under construction.

 BRepBuilderAPI_MakeWire (const TopoDS_Edge &E)
 Make a Wire from an edge.

 BRepBuilderAPI_MakeWire (const TopoDS_Edge &E1, const TopoDS_Edge &E2)
 Make a Wire from two edges.

 BRepBuilderAPI_MakeWire (const TopoDS_Edge &E1, const TopoDS_Edge &E2, const TopoDS_Edge &E3)
 Make a Wire from three edges.

 BRepBuilderAPI_MakeWire (const TopoDS_Edge &E1, const TopoDS_Edge &E2, const TopoDS_Edge &E3, const TopoDS_Edge &E4)
 Make a Wire from four edges.
//! Constructs a wire

 BRepBuilderAPI_MakeWire (const TopoDS_Wire &W)
 Make a Wire from a Wire. Usefull for adding later.

 BRepBuilderAPI_MakeWire (const TopoDS_Wire &W, const TopoDS_Edge &E)
 Add an edge to a wire.

void Add (const TopoDS_Edge &E)
 Adds the edge E to the wire under construction.
E must be connectable to the wire under construction, and, unless it
is the first edge of the wire, must satisfy the following
condition: one of its vertices must be geometrically coincident
with one of the vertices of the wire (provided that the highest
tolerance factor is assigned to the two vertices). It could also
be the same vertex.
Warning
If E is not connectable to the wire under construction it is not
added. The function Error will return
BRepBuilderAPI_DisconnectedWire, the function IsDone will return
false and the function Wire will raise an error, until a new
connectable edge is added.

void Add (const TopoDS_Wire &W)
 Add the edges of <W> to the current wire.

void Add (const TopTools_ListOfShape &L)
 Adds the edges of <L> to the current wire. The
edges are not to be consecutive. But they are to
be all connected geometrically or topologically.
If some of them are not connected the Status give
DisconnectedWire but the "Maker" is Done() and you
can get the partial result. (ie connected to the
first edgeof the list <L>)

virtual Standard_Boolean IsDone () const
 Returns true if this algorithm contains a valid wire.
IsDone returns false if:

BRepBuilderAPI_WireError Error () const
 Returns the construction status

const TopoDS_WireWire () const
 Returns the constructed wire; or the part of the wire
under construction already built.
Exceptions StdFail_NotDone if a wire is not built.

 operator TopoDS_Wire () const
const TopoDS_EdgeEdge () const
 Returns the last edge added to the wire under construction.
Warning

const TopoDS_VertexVertex () const
 Returns the last vertex of the last edge added to the
wire under construction.
Warning
A null vertex is returned if there are no edges in the wire
under construction, or if the last edge which you tried to
add was not connectableR


Detailed Description


Constructor & Destructor Documentation

  • from the TopoDS_Wire W composed of the edge E, or
  • from edge E, or
  • from two edges E1 and E2, or
  • from three edges E1, E2 and E3, or
  • from four edges E1, E2, E3 and E4.
    Further edges can be added using the function Add.
    Given edges are added in a sequence. Each of them
    must be connectable to the wire under construction,
    and so must satisfy the following condition (unless it is
    the first edge of the wire): one of its vertices must be
    geometrically coincident with one of the vertices of the
    wire (provided that the highest tolerance factor is
    assigned to the two vertices). It could also be the same vertex.
    Warning
    If an edge is not connectable to the wire under
    construction it is not added. The function Error will
    return BRepBuilderAPI_DisconnectedWire, the
    function IsDone will return false and the function Wire
    will raise an error, until a new connectable edge is added.

Member Function Documentation

  • This edge can be different from the original one (the
    argument of the function Add, for instance,)
  • A null edge is returned if there are no edges in the
    wire under construction, or if the last edge which you
    tried to add was not connectable..
  • BRepBuilderAPI_WireDone if the wire is built, or
  • another value of the BRepBuilderAPI_WireError
    enumeration indicating why the construction failed.
  • there are no edges in the wire, or
  • the last edge which you tried to add was not connectable.

Reimplemented from BRepBuilderAPI_Command.

BRepBuilderAPI_MakeWire::operator TopoDS_Wire ( ) const

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