OCC Main Page | ModelingAlgorithms | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingAlgorithms
TKTopAlgo
BRepBuilderAPI


BRepBuilderAPI_MakePolygon Class Reference

Describes functions to build polygonal wires. A
polygonal wire can be built from any number of points
or vertices, and consists of a sequence of connected
rectilinear edges.
When a point or vertex is added to the polygon if
it is identic to the previous point no edge is
built. The method added can be used to test it.
Construction of a Polygonal Wire
You can construct:
- a complete polygonal wire by defining all its points
or vertices (limited to four), or
- an empty polygonal wire and add its points or
vertices in sequence (unlimited number).
A MakePolygon object provides a framework for:
- initializing the construction of a polygonal wire,
- adding points or vertices to the polygonal wire under construction, and
- consulting the result.
.

#include <BRepBuilderAPI_MakePolygon.hxx>

Inheritance diagram for BRepBuilderAPI_MakePolygon:

Inheritance graph
[legend]

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT BRepBuilderAPI_MakePolygon ()
 Initializes an empty polygonal wire, to which points or
vertices are added using the Add function.
As soon as the polygonal wire under construction
contains vertices, it can be consulted using the Wire function.
.
Standard_EXPORT BRepBuilderAPI_MakePolygon (const gp_Pnt &P1, const gp_Pnt &P2)
Standard_EXPORT BRepBuilderAPI_MakePolygon (const gp_Pnt &P1, const gp_Pnt &P2, const gp_Pnt &P3, const Standard_Boolean Close=Standard_False)
Standard_EXPORT BRepBuilderAPI_MakePolygon (const gp_Pnt &P1, const gp_Pnt &P2, const gp_Pnt &P3, const gp_Pnt &P4, const Standard_Boolean Close=Standard_False)
 Constructs a polygonal wire from 2, 3 or 4 points. Vertices are
automatically created on the given points. The polygonal wire is
closed if Close is true; otherwise it is open. Further vertices can
be added using the Add function. The polygonal wire under
construction can be consulted at any time by using the Wire function.
Example
//an open polygon from four points
TopoDS_Wire W = BRepBuilderAPI_MakePolygon(P1,P2,P3,P4);
Warning: The process is equivalent to:
· initializing an empty polygonal wire,
· and adding the given points in sequence.
Consequently, be careful when using this function: if the
sequence of points p1 - p2 - p1 is found among the arguments of the
constructor, you will create a polygonal wire with two
consecutive coincident edges.
.
Standard_EXPORT BRepBuilderAPI_MakePolygon (const TopoDS_Vertex &V1, const TopoDS_Vertex &V2)
Standard_EXPORT BRepBuilderAPI_MakePolygon (const TopoDS_Vertex &V1, const TopoDS_Vertex &V2, const TopoDS_Vertex &V3, const Standard_Boolean Close=Standard_False)
Standard_EXPORT BRepBuilderAPI_MakePolygon (const TopoDS_Vertex &V1, const TopoDS_Vertex &V2, const TopoDS_Vertex &V3, const TopoDS_Vertex &V4, const Standard_Boolean Close=Standard_False)
 Constructs a polygonal wire from
2, 3 or 4 vertices. The polygonal wire is closed if Close is true;
otherwise it is open (default value). Further vertices can be
added using the Add function. The polygonal wire under
construction can be consulted at any time by using the Wire function.
Example
//a closed triangle from three vertices
TopoDS_Wire W = BRepBuilderAPI_MakePolygon(V1,V2,V3,Standard_True);
Warning
The process is equivalent to:
- initializing an empty polygonal wire,
- then adding the given points in sequence.
So be careful, as when using this function, you could create a
polygonal wire with two consecutive coincident edges if
the sequence of vertices v1 - v2 - v1 is found among the
constructor's arguments.
.
Standard_EXPORT void Add (const gp_Pnt &P)
Standard_EXPORT void Add (const TopoDS_Vertex &V)
 Adds the point P or the vertex V at the end of the
polygonal wire under construction. A vertex is
automatically created on the point P.
Warning
- When P or V is coincident to the previous vertex,
no edge is built. The method Added can be used to
test for this. Neither P nor V is checked to verify
that it is coincident with another vertex than the last
one, of the polygonal wire under construction. It is
also possible to add vertices on a closed polygon
(built for example by using a constructor which
declares the polygon closed, or after the use of the Close function).
Consequently, be careful using this function: you might create:
- a polygonal wire with two consecutive coincident edges, or
- a non manifold polygonal wire.
- P or V is not checked to verify if it is
coincident with another vertex but the last one, of
the polygonal wire under construction. It is also
possible to add vertices on a closed polygon (built
for example by using a constructor which declares
the polygon closed, or after the use of the Close function).
Consequently, be careful when using this function: you might create:
- a polygonal wire with two consecutive coincident edges, or
- a non-manifold polygonal wire.
.
Standard_EXPORT Standard_Boolean Added () const
 Returns true if the last vertex added to the constructed
polygonal wire is not coincident with the previous one.
.
Standard_EXPORT void Close ()
 Closes the polygonal wire under construction. Note - this
is equivalent to adding the first vertex to the polygonal
wire under construction.
.
Standard_EXPORT const TopoDS_Vertex & FirstVertex () const
Standard_EXPORT const TopoDS_Vertex & LastVertex () const
 Returns the first or the last vertex of the polygonal wire under construction.
If the constructed polygonal wire is closed, the first and the last vertices are identical.
.
virtual Standard_EXPORT Standard_Boolean IsDone () const
 Returns true if this algorithm contains a valid polygonal
wire (i.e. if there is at least one edge).
IsDone returns false if fewer than two vertices have
been chained together by this construction algorithm.
.
Standard_EXPORT const TopoDS_Edge & Edge () const
 Returns the edge built between the last two points or
vertices added to the constructed polygonal wire under construction.
Warning
If there is only one vertex in the polygonal wire, the result is a null edge.
.
Standard_EXPORT operator TopoDS_Edge () const
Standard_EXPORT const TopoDS_Wire & Wire () const
 Returns the constructed polygonal wire, or the already
built part of the polygonal wire under construction.
Exceptions
StdFail_NotDone if the wire is not built, i.e. if fewer than
two vertices have been chained together by this construction algorithm.
.
Standard_EXPORT operator TopoDS_Wire () const

Private Attributes

BRepLib_MakePolygon myMakePolygon

Constructor & Destructor Documentation

Standard_EXPORT BRepBuilderAPI_MakePolygon::BRepBuilderAPI_MakePolygon  ) 
 

Standard_EXPORT BRepBuilderAPI_MakePolygon::BRepBuilderAPI_MakePolygon const gp_Pnt &  P1,
const gp_Pnt &  P2
 

Standard_EXPORT BRepBuilderAPI_MakePolygon::BRepBuilderAPI_MakePolygon const gp_Pnt &  P1,
const gp_Pnt &  P2,
const gp_Pnt &  P3,
const Standard_Boolean  Close = Standard_False
 

Standard_EXPORT BRepBuilderAPI_MakePolygon::BRepBuilderAPI_MakePolygon const gp_Pnt &  P1,
const gp_Pnt &  P2,
const gp_Pnt &  P3,
const gp_Pnt &  P4,
const Standard_Boolean  Close = Standard_False
 

Standard_EXPORT BRepBuilderAPI_MakePolygon::BRepBuilderAPI_MakePolygon const TopoDS_Vertex &  V1,
const TopoDS_Vertex &  V2
 

Standard_EXPORT BRepBuilderAPI_MakePolygon::BRepBuilderAPI_MakePolygon const TopoDS_Vertex &  V1,
const TopoDS_Vertex &  V2,
const TopoDS_Vertex &  V3,
const Standard_Boolean  Close = Standard_False
 

Standard_EXPORT BRepBuilderAPI_MakePolygon::BRepBuilderAPI_MakePolygon const TopoDS_Vertex &  V1,
const TopoDS_Vertex &  V2,
const TopoDS_Vertex &  V3,
const TopoDS_Vertex &  V4,
const Standard_Boolean  Close = Standard_False
 


Member Function Documentation

Standard_EXPORT void BRepBuilderAPI_MakePolygon::Add const TopoDS_Vertex &  V  ) 
 

Standard_EXPORT void BRepBuilderAPI_MakePolygon::Add const gp_Pnt &  P  ) 
 

Standard_EXPORT Standard_Boolean BRepBuilderAPI_MakePolygon::Added  )  const
 

Standard_EXPORT void BRepBuilderAPI_MakePolygon::Close  ) 
 

Standard_EXPORT const TopoDS_Edge& BRepBuilderAPI_MakePolygon::Edge  )  const
 

Standard_EXPORT const TopoDS_Vertex& BRepBuilderAPI_MakePolygon::FirstVertex  )  const
 

virtual Standard_EXPORT Standard_Boolean BRepBuilderAPI_MakePolygon::IsDone  )  const [virtual]
 

Reimplemented from BRepBuilderAPI_Command.

Standard_EXPORT const TopoDS_Vertex& BRepBuilderAPI_MakePolygon::LastVertex  )  const
 

void BRepBuilderAPI_MakePolygon::operator delete void *  anAddress  )  [inline]
 

Reimplemented from BRepBuilderAPI_MakeShape.

void* BRepBuilderAPI_MakePolygon::operator new size_t  size  )  [inline]
 

Reimplemented from BRepBuilderAPI_MakeShape.

void* BRepBuilderAPI_MakePolygon::operator new size_t  ,
void *  anAddress
[inline]
 

Reimplemented from BRepBuilderAPI_MakeShape.

Standard_EXPORT BRepBuilderAPI_MakePolygon::operator TopoDS_Edge  )  const
 

Standard_EXPORT BRepBuilderAPI_MakePolygon::operator TopoDS_Wire  )  const
 

Standard_EXPORT const TopoDS_Wire& BRepBuilderAPI_MakePolygon::Wire  )  const
 


Field Documentation

BRepLib_MakePolygon BRepBuilderAPI_MakePolygon::myMakePolygon [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:41:05 2008 for OpenCASCADE by  doxygen 1.4.1