Open CASCADE Technology  7.3.1.dev
Public Member Functions
Poly_PolygonOnTriangulation Class Reference

This class provides a polygon in 3D space, based on the triangulation of a surface. It may be the approximate representation of a curve on the surface, or more generally the shape. A PolygonOnTriangulation is defined by a table of nodes. Each node is an index in the table of nodes specific to a triangulation, and represents a point on the surface. If the polygon is closed, the index of the point of closure is repeated at the end of the table of nodes. If the polygon is an approximate representation of a curve on a surface, you can associate with each of its nodes the value of the parameter of the corresponding point on the curve.represents a 3d Polygon. More...

#include <Poly_PolygonOnTriangulation.hxx>

Inheritance diagram for Poly_PolygonOnTriangulation:
Inheritance graph
[legend]

Public Member Functions

 Poly_PolygonOnTriangulation (const TColStd_Array1OfInteger &Nodes)
 Constructs a 3D polygon on the triangulation of a shape, defined by the table of nodes, <Nodes>. More...
 
 Poly_PolygonOnTriangulation (const TColStd_Array1OfInteger &Nodes, const TColStd_Array1OfReal &Parameters)
 Constructs a 3D polygon on the triangulation of a shape, defined by: More...
 
virtual Handle< Poly_PolygonOnTriangulationCopy () const
 Creates a copy of current polygon. 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_Polygones2D. More...
 
Standard_Integer NbNodes () const
 Returns the number of nodes for 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 TColStd_Array1OfIntegerNodes () const
 Returns the table of nodes for this polygon. A node value is an index in the table of nodes specific to an existing triangulation of a shape. More...
 
Standard_Boolean HasParameters () const
 Returns true if parameters are associated with the nodes in this polygon. More...
 
Handle< TColStd_HArray1OfReal > Parameters () const
 Returns the table of the parameters associated with each node in this polygon. Warning Use the function HasParameters to check if parameters are associated with the nodes in this polygon. 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 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_TransientThis () 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, based on the triangulation of a surface. It may be the approximate representation of a curve on the surface, or more generally the shape. A PolygonOnTriangulation is defined by a table of nodes. Each node is an index in the table of nodes specific to a triangulation, and represents a point on the surface. If the polygon is closed, the index of the point of closure is repeated at the end of the table of nodes. If the polygon is an approximate representation of a curve on a surface, you can associate with each of its nodes the value of the parameter of the corresponding point on the curve.represents a 3d Polygon.

Constructor & Destructor Documentation

◆ Poly_PolygonOnTriangulation() [1/2]

Poly_PolygonOnTriangulation::Poly_PolygonOnTriangulation ( const TColStd_Array1OfInteger Nodes)

Constructs a 3D polygon on the triangulation of a shape, defined by the table of nodes, <Nodes>.

◆ Poly_PolygonOnTriangulation() [2/2]

Poly_PolygonOnTriangulation::Poly_PolygonOnTriangulation ( const TColStd_Array1OfInteger Nodes,
const TColStd_Array1OfReal Parameters 
)

Constructs a 3D polygon on the triangulation of a shape, defined by:

  • the table of nodes, Nodes, and the table of parameters, <Parameters>. where:
  • a node value is an index in the table of nodes specific to an existing triangulation of a shape
  • and a parameter value is the value of the parameter of the corresponding point on the curve approximated by the constructed polygon. Warning The tables Nodes and Parameters must be the same size. This property is not checked at construction time.

Member Function Documentation

◆ Copy()

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

Creates a copy of current polygon.

◆ Deflection() [1/2]

Standard_Real Poly_PolygonOnTriangulation::Deflection ( ) const

Returns the deflection of this polygon.

◆ Deflection() [2/2]

void Poly_PolygonOnTriangulation::Deflection ( const Standard_Real  D)

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

◆ HasParameters()

Standard_Boolean Poly_PolygonOnTriangulation::HasParameters ( ) const

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

◆ NbNodes()

Standard_Integer Poly_PolygonOnTriangulation::NbNodes ( ) const

Returns the number of nodes for 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 TColStd_Array1OfInteger& Poly_PolygonOnTriangulation::Nodes ( ) const

Returns the table of nodes for this polygon. A node value is an index in the table of nodes specific to an existing triangulation of a shape.

◆ Parameters()

Handle< TColStd_HArray1OfReal > Poly_PolygonOnTriangulation::Parameters ( ) const

Returns the table of the parameters associated with each node in this polygon. Warning Use the function HasParameters to check if parameters are associated with the nodes in this polygon.


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