# Poly_Polygon3D Class Reference

This class Provides a polygon in 3D space. It is generally an approximate representation of a curve. A Polygon3D is defined by a table of nodes. Each node is a 3D point. If the polygon is closed, the point of closure is repeated at the end of the table of nodes. If the polygon is an approximate representation of a curve, you can associate with each of its nodes the value of the parameter of the corresponding point on the curve. More...

`#include <Poly_Polygon3D.hxx>`

Inheritance diagram for Poly_Polygon3D: [legend]

## Public Member Functions

Poly_Polygon3D (const TColgp_Array1OfPnt &Nodes)
onstructs a 3D polygon defined by the table of points, Nodes. More...

Poly_Polygon3D (const TColgp_Array1OfPnt &Nodes, const TColStd_Array1OfReal &Parameters)
Constructs a 3D polygon defined by the table of points, Nodes, and the parallel table of parameters, Parameters, where each value of the table Parameters is the parameter of the corresponding point on the curve approximated by the constructed polygon. Warning Both the Nodes and Parameters tables must have the same bounds. This property is not checked at construction time. More...

Standard_Real Deflection () const
Returns the deflection of this polygon. More...

void Deflection (const Standard_Real D)
Sets the deflection of this polygon to D. See more on deflection in Poly_Polygon2D. More...

Standard_Integer NbNodes () const
Returns the number of nodes in this polygon. Note: If the polygon is closed, the point of closure is repeated at the end of its table of nodes. Thus, on a closed triangle the function NbNodes returns 4. More...

const TColgp_Array1OfPntNodes () const
Returns the table of nodes for this polygon. More...

Standard_Boolean HasParameters () const
Returns the table of the parameters associated with each node in this polygon. HasParameters function checks if parameters are associated with the nodes of this polygon. More...

const TColStd_Array1OfRealParameters () const
Returns true if parameters are associated with the nodes in this polygon. More...

TColStd_Array1OfRealChangeParameters () const
Returns the table of the parameters associated with each node in this polygon. ChangeParameters function returnes the array as shared. Therefore if the table is selected by reference you can, by simply modifying it, directly modify the data structure of this polygon. More... Public Member Functions inherited from MMgt_TShared
virtual void Delete () const
Memory deallocator for transient classes. More... Public Member Functions inherited from Standard_Transient
Standard_Transient ()
Empty constructor. More...

Standard_Transient (const Standard_Transient &)
Copy constructor – does nothing. More...

Standard_Transientoperator= (const Standard_Transient &)
Assignment operator, needed to avoid copying reference counter. More...

virtual ~Standard_Transient ()
Destructor must be virtual. More...

virtual const
Handle_Standard_Type &
DynamicType () const

Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
Returns a true value if this is an instance of Type. More...

Standard_Boolean IsInstance (const Standard_CString theTypeName) const
Returns a true value if this is an instance of TypeName. More...

Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

Standard_Boolean IsKind (const Standard_CString theTypeName) const
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

virtual Handle_Standard_Transient This () const
Returns a Handle which references this object. Must never be called to objects created in stack. More...

Standard_Integer GetRefCount () const
Get the reference counter of this object. More...

## Detailed Description

This class Provides a polygon in 3D space. It is generally an approximate representation of a curve. A Polygon3D is defined by a table of nodes. Each node is a 3D point. If the polygon is closed, the point of closure is repeated at the end of the table of nodes. If the polygon is an approximate representation of a curve, you can associate with each of its nodes the value of the parameter of the corresponding point on the curve.

## Constructor & Destructor Documentation

 Poly_Polygon3D::Poly_Polygon3D ( const TColgp_Array1OfPnt & Nodes )

onstructs a 3D polygon defined by the table of points, Nodes.

 Poly_Polygon3D::Poly_Polygon3D ( const TColgp_Array1OfPnt & Nodes, const TColStd_Array1OfReal & Parameters )

Constructs a 3D polygon defined by the table of points, Nodes, and the parallel table of parameters, Parameters, where each value of the table Parameters is the parameter of the corresponding point on the curve approximated by the constructed polygon. Warning Both the Nodes and Parameters tables must have the same bounds. This property is not checked at construction time.

## Member Function Documentation

 TColStd_Array1OfReal& Poly_Polygon3D::ChangeParameters ( ) const

Returns the table of the parameters associated with each node in this polygon. ChangeParameters function returnes the array as shared. Therefore if the table is selected by reference you can, by simply modifying it, directly modify the data structure of this polygon.

 Standard_Real Poly_Polygon3D::Deflection ( ) const

Returns the deflection of this polygon.

 void Poly_Polygon3D::Deflection ( const Standard_Real D )

Sets the deflection of this polygon to D. See more on deflection in Poly_Polygon2D.

 Standard_Boolean Poly_Polygon3D::HasParameters ( ) const

Returns the table of the parameters associated with each node in this polygon. HasParameters function checks if parameters are associated with the nodes of this polygon.

 Standard_Integer Poly_Polygon3D::NbNodes ( ) const

Returns the number of nodes in this polygon. Note: If the polygon is closed, the point of closure is repeated at the end of its table of nodes. Thus, on a closed triangle the function NbNodes returns 4.

 const TColgp_Array1OfPnt& Poly_Polygon3D::Nodes ( ) const

Returns the table of nodes for this polygon.

 const TColStd_Array1OfReal& Poly_Polygon3D::Parameters ( ) const

Returns true if parameters are associated with the nodes in this polygon.

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