Poly_Polygon2D Class Reference

Provides a polygon in 2D space (for example, in the parametric space of a surface). It is generally an approximate representation of a curve. A Polygon2D is defined by a table of nodes. Each node is a 2D point. If the polygon is closed, the point of closure is repeated at the end of the table of nodes. More...

#include <Poly_Polygon2D.hxx>

Inheritance diagram for Poly_Polygon2D:

Public Member Functions
	Poly_Polygon2D (const Standard_Integer theNbNodes)
	Constructs a 2D polygon with specified number of nodes.
	Poly_Polygon2D (const TColgp_Array1OfPnt2d &Nodes)
	Constructs a 2D polygon defined by the table of points, <Nodes>.
Standard_Real	Deflection () const
	Returns the deflection of this polygon. Deflection is used in cases where the polygon is an approximate representation of a curve. Deflection represents the maximum distance permitted between any point on the curve and the corresponding point on the polygon. By default the deflection value is equal to 0. An algorithm using this 2D polygon with a deflection value equal to 0 considers that it is working with a true polygon and not with an approximate representation of a curve. The Deflection function is used to modify the deflection value of this polygon. The deflection value can be used by any algorithm working with 2D polygons. For example:
void	Deflection (const Standard_Real theDefl)
	Sets the deflection of this polygon.
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.
const TColgp_Array1OfPnt2d &	Nodes () const
	Returns the table of nodes for this polygon.
TColgp_Array1OfPnt2d &	ChangeNodes ()
	Returns the table of nodes for this polygon.
virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::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.
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.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Provides a polygon in 2D space (for example, in the parametric space of a surface). It is generally an approximate representation of a curve. A Polygon2D is defined by a table of nodes. Each node is a 2D point. If the polygon is closed, the point of closure is repeated at the end of the table of nodes.

Constructor & Destructor Documentation

Poly_Polygon2D() [1/2]

Poly_Polygon2D::Poly_Polygon2D ( const Standard_Integer theNbNodes )

explicit

Constructs a 2D polygon with specified number of nodes.

Poly_Polygon2D() [2/2]

Poly_Polygon2D::Poly_Polygon2D

(

const TColgp_Array1OfPnt2d &

Nodes

)

Constructs a 2D polygon defined by the table of points, <Nodes>.

Member Function Documentation

ChangeNodes()

TColgp_Array1OfPnt2d & Poly_Polygon2D::ChangeNodes ( )

inline

Returns the table of nodes for this polygon.

Deflection() [1/2]

Standard_Real Poly_Polygon2D::Deflection ( ) const

inline

Returns the deflection of this polygon. Deflection is used in cases where the polygon is an approximate representation of a curve. Deflection represents the maximum distance permitted between any point on the curve and the corresponding point on the polygon. By default the deflection value is equal to 0. An algorithm using this 2D polygon with a deflection value equal to 0 considers that it is working with a true polygon and not with an approximate representation of a curve. The Deflection function is used to modify the deflection value of this polygon. The deflection value can be used by any algorithm working with 2D polygons. For example:

• An algorithm may use a unique deflection value for all its polygons. In this case it is not necessary to use the Deflection function.
• Or an algorithm may want to attach a different deflection to each polygon. In this case, the Deflection function is used to set a value on each polygon, and later to fetch the value.

Deflection() [2/2]

void Poly_Polygon2D::Deflection ( const Standard_Real theDefl )

inline

Sets the deflection of this polygon.

DumpJson()

virtual void Poly_Polygon2D::DumpJson ( Standard_OStream & theOStream, Standard_Integer theDepth = -1 ) const

virtual

Dumps the content of me into the stream.

NbNodes()

Standard_Integer Poly_Polygon2D::NbNodes ( ) const

inline

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.

Nodes()

const TColgp_Array1OfPnt2d & Poly_Polygon2D::Nodes ( ) const

inline

Returns the table of nodes for this polygon.

---

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

• Poly_Polygon2D.hxx