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 Standard_Integer theNbNodes, const Standard_Boolean theHasParams)
	Constructs a 3D polygon with specific number of nodes. More...

	Poly_Polygon3D (const TColgp_Array1OfPnt &Nodes)
	Constructs 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...

virtual Handle< Poly_Polygon3D >	Copy () const
	Creates a copy of current polygon. More...

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

void	Deflection (const Standard_Real theDefl)
	Sets the deflection of this polygon. 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_Array1OfPnt &	Nodes () const
	Returns the table of nodes for this polygon. More...

TColgp_Array1OfPnt &	ChangeNodes ()
	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_Array1OfReal &	Parameters () const
	Returns true if parameters are associated with the nodes in this polygon. More...

TColStd_Array1OfReal &	ChangeParameters () const
	Returns the table of the parameters associated with each node in this polygon. ChangeParameters function returns 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...

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

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

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

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

virtual void	Delete () const
	Memory deallocator for transient classes. More...

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object. More...

Standard_Boolean	IsInstance (const opencascade::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 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. 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...

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

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

void	IncrementRefCounter () const
	Increments the reference counter of this object. More...

Standard_Integer	DecrementRefCounter () const
	Decrements the reference counter of this object; returns the decremented value. More...

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object. More...

Static Public Member Functions inherited from Standard_Transient
static const char *	get_type_name ()
	Returns a type descriptor about this object. More...

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class. 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() [1/3]

Poly_Polygon3D::Poly_Polygon3D	(	const Standard_Integer	theNbNodes,
		const Standard_Boolean	theHasParams
	)

Constructs a 3D polygon with specific number of nodes.

◆ Poly_Polygon3D() [2/3]

Poly_Polygon3D::Poly_Polygon3D ( const TColgp_Array1OfPnt & Nodes )

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

◆ Poly_Polygon3D() [3/3]

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

◆ ChangeNodes()

TColgp_Array1OfPnt& Poly_Polygon3D::ChangeNodes ( )

inline

Returns the table of nodes for this polygon.

◆ ChangeParameters()

TColStd_Array1OfReal& Poly_Polygon3D::ChangeParameters ( ) const

inline

Returns the table of the parameters associated with each node in this polygon. ChangeParameters function returns 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.

◆ Copy()

virtual Handle< Poly_Polygon3D > Poly_Polygon3D::Copy ( ) const

virtual

Creates a copy of current polygon.

◆ Deflection() [1/2]

Standard_Real Poly_Polygon3D::Deflection ( ) const

inline

Returns the deflection of this polygon.

◆ Deflection() [2/2]

void Poly_Polygon3D::Deflection ( const Standard_Real theDefl )

inline

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

◆ DumpJson()

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

virtual

Dumps the content of me into the stream.

◆ HasParameters()

Standard_Boolean Poly_Polygon3D::HasParameters ( ) const

inline

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.

◆ NbNodes()

Standard_Integer Poly_Polygon3D::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_Array1OfPnt& Poly_Polygon3D::Nodes ( ) const

inline

Returns the table of nodes for this polygon.

◆ Parameters()

const TColStd_Array1OfReal& Poly_Polygon3D::Parameters ( ) const

inline

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

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

Poly_Polygon3D.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Poly_Polygon3D() [1/3]

◆ Poly_Polygon3D() [2/3]

◆ Poly_Polygon3D() [3/3]

Member Function Documentation

◆ ChangeNodes()

◆ ChangeParameters()

◆ Copy()

◆ Deflection() [1/2]

◆ Deflection() [2/2]

◆ DumpJson()

◆ HasParameters()

◆ NbNodes()

◆ Nodes()

◆ Parameters()