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:

Public Member Functions
	BRepBuilderAPI_MakeWire ()
	Constructs an empty wire framework, to which edges <br> 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. More...
	BRepBuilderAPI_MakeWire (const TopoDS_Edge &E)
	Make a Wire from an edge. More...
	BRepBuilderAPI_MakeWire (const TopoDS_Edge &E1, const TopoDS_Edge &E2)
	Make a Wire from two edges. More...
	BRepBuilderAPI_MakeWire (const TopoDS_Edge &E1, const TopoDS_Edge &E2, const TopoDS_Edge &E3)
	Make a Wire from three edges. More...
	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 More...
	BRepBuilderAPI_MakeWire (const TopoDS_Wire &W)
	Make a Wire from a Wire. Usefull for adding later. More...
	BRepBuilderAPI_MakeWire (const TopoDS_Wire &W, const TopoDS_Edge &E)
	Add an edge to a wire. More...
void	Add (const TopoDS_Edge &E)
	Adds the edge E to the wire under construction. <br> 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. More...
void	Add (const TopoDS_Wire &W)
	Add the edges of <W> to the current wire. More...
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>) More...
virtual Standard_Boolean	IsDone () const
	Returns true if this algorithm contains a valid wire. <br> IsDone returns false if: More...
BRepBuilderAPI_WireError	Error () const
	Returns the construction status More...
const TopoDS_Wire &	Wire () const
	Returns the constructed wire; or the part of the wire <br> under construction already built. Exceptions StdFail_NotDone if a wire is not built. More...
	operator TopoDS_Wire () const
const TopoDS_Edge &	Edge () const
	Returns the last edge added to the wire under construction. <br> Warning More...
const TopoDS_Vertex &	Vertex () const
	Returns the last vertex of the last edge added to the <br> 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 More...
Public Member Functions inherited from BRepBuilderAPI_MakeShape
virtual void	Delete ()
virtual	~BRepBuilderAPI_MakeShape ()
virtual void	Build ()
	This is called by Shape(). It does nothing but may be redefined. More...
const TopoDS_Shape &	Shape () const
	Returns a shape built by the shape construction algorithm. <br> Raises exception StdFail_NotDone if the shape was not built. More...
	operator TopoDS_Shape () const
virtual const TopTools_ListOfShape &	Generated (const TopoDS_Shape &S)
	Returns the list of shapes generated from the shape <S>. More...
virtual const TopTools_ListOfShape &	Modified (const TopoDS_Shape &S)
	Returns the list of shapes modified from the shape <S>. More...
virtual Standard_Boolean	IsDeleted (const TopoDS_Shape &S)
	Returns true if the shape S has been deleted. More...
Public Member Functions inherited from BRepBuilderAPI_Command
virtual	~BRepBuilderAPI_Command ()
void	Check () const
	Raises NotDone if done is false. More...

Additional Inherited Members
Protected Member Functions inherited from BRepBuilderAPI_MakeShape
	BRepBuilderAPI_MakeShape ()
Protected Member Functions inherited from BRepBuilderAPI_Command
	BRepBuilderAPI_Command ()
	Set done to False. More...
void	Done ()
	Set done to true. More...
void	NotDone ()
	Set done to false. More...
Protected Attributes inherited from BRepBuilderAPI_MakeShape
TopoDS_Shape	myShape
TopTools_ListOfShape	myGenerated

Detailed Description

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:

• no edge (an empty wire), or
  
• edges of an existing wire, or
  
• up to four connectable edges.
  In order to be added to a wire under construction, an
  edge (unless it is the first one) 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.
  
• The given edge is shared by the wire if it contains:
  
  • two vertices, identical to two vertices of the wire
    under construction (a general case of the wire closure), or
    
  • one vertex, identical to a vertex of the wire under
    construction; the other vertex not being
    geometrically coincident with another vertex of the wire.
    
• In other cases, when one of the vertices of the edge
  is simply geometrically coincident with a vertex of the
  wire under construction (provided that the highest
  tolerance factor is assigned to the two vertices), the
  given edge is first copied and the coincident vertex is
  replaced in this new edge, by the coincident vertex of the wire.
  Note: it is possible to build non manifold wires using this construction tool.
  A MakeWire object provides a framework for:
  
• initializing the construction of a wire,
  
• adding edges to the wire under construction, and
  
• consulting the result.
  

Constructor & Destructor Documentation

BRepBuilderAPI_MakeWire::BRepBuilderAPI_MakeWire

(

)

 Constructs an empty wire framework, to which edges <br>

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::BRepBuilderAPI_MakeWire

(

const TopoDS_Edge &

E

)

Make a Wire from an edge.

BRepBuilderAPI_MakeWire::BRepBuilderAPI_MakeWire	(	const TopoDS_Edge &	E1,
		const TopoDS_Edge &	E2
	)

Make a Wire from two edges.

BRepBuilderAPI_MakeWire::BRepBuilderAPI_MakeWire	(	const TopoDS_Edge &	E1,
		const TopoDS_Edge &	E2,
		const TopoDS_Edge &	E3
	)

Make a Wire from three edges.

BRepBuilderAPI_MakeWire::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

• 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.
  

BRepBuilderAPI_MakeWire::BRepBuilderAPI_MakeWire

(

const TopoDS_Wire &

W

)

Make a Wire from a Wire. Usefull for adding later.

BRepBuilderAPI_MakeWire::BRepBuilderAPI_MakeWire	(	const TopoDS_Wire &	W,
		const TopoDS_Edge &	E
	)

Add an edge to a wire.

Member Function Documentation

void BRepBuilderAPI_MakeWire::Add

(

const TopoDS_Edge &

E

)

  Adds the edge E to the wire under construction. <br>

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 BRepBuilderAPI_MakeWire::Add

(

const TopoDS_Wire &

W

)

Add the edges of <W> to the current wire.

void BRepBuilderAPI_MakeWire::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>)

const TopoDS_Edge& BRepBuilderAPI_MakeWire::Edge

(

)

const

 Returns the last edge added to the wire under construction. <br>

Warning

• 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_WireError BRepBuilderAPI_MakeWire::Error

(

)

const

Returns the construction status

• BRepBuilderAPI_WireDone if the wire is built, or
  
• another value of the BRepBuilderAPI_WireError
  enumeration indicating why the construction failed.
  

virtual Standard_Boolean BRepBuilderAPI_MakeWire::IsDone ( ) const

virtual

 Returns true if this algorithm contains a valid wire. <br>

IsDone returns false if:

• 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

const TopoDS_Vertex& BRepBuilderAPI_MakeWire::Vertex

(

)

const

 Returns the last vertex of the last edge added to the <br>

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

const TopoDS_Wire& BRepBuilderAPI_MakeWire::Wire

(

)

const

 Returns the constructed wire; or the part of the wire <br>

under construction already built.
Exceptions StdFail_NotDone if a wire is not built.

---

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

• BRepBuilderAPI_MakeWire.hxx