Open CASCADE Technology  7.5.0
Public Member Functions | Protected Attributes

Poly_Triangulation Class Reference

Provides a triangulation for a surface, a set of surfaces, or more generally a shape. A triangulation consists of an approximate representation of the actual shape, using a collection of points and triangles. The points are located on the surface. The edges of the triangles connect adjacent points with a straight line that approximates the true curve on the surface. A triangulation comprises: More...

#include <Poly_Triangulation.hxx>

Inheritance diagram for Poly_Triangulation:
Inheritance graph
[legend]

Public Member Functions

 Poly_Triangulation (const Standard_Integer nbNodes, const Standard_Integer nbTriangles, const Standard_Boolean UVNodes)
 Constructs a triangulation from a set of triangles. The triangulation is initialized without a triangle or a node, but capable of containing nbNodes nodes, and nbTriangles triangles. Here the UVNodes flag indicates whether 2D nodes will be associated with 3D ones, (i.e. to enable a 2D representation). More...
 
 Poly_Triangulation (const TColgp_Array1OfPnt &Nodes, const Poly_Array1OfTriangle &Triangles)
 Constructs a triangulation from a set of triangles. The triangulation is initialized with 3D points from Nodes and triangles from Triangles. More...
 
 Poly_Triangulation (const TColgp_Array1OfPnt &Nodes, const TColgp_Array1OfPnt2d &UVNodes, const Poly_Array1OfTriangle &Triangles)
 Constructs a triangulation from a set of triangles. The triangulation is initialized with 3D points from Nodes, 2D points from UVNodes and triangles from Triangles, where coordinates of a 2D point from UVNodes are the (u, v) parameters of the corresponding 3D point from Nodes on the surface approximated by the constructed triangulation. More...
 
virtual Handle< Poly_TriangulationCopy () const
 Creates full copy of current triangulation. More...
 
 Poly_Triangulation (const Handle< Poly_Triangulation > &theTriangulation)
 Copy constructor for triangulation. More...
 
Standard_Real Deflection () const
 Returns the deflection of this triangulation. More...
 
void Deflection (const Standard_Real theDeflection)
 Sets the deflection of this triangulation to theDeflection. See more on deflection in Polygon2D. More...
 
void RemoveUVNodes ()
 Deallocates the UV nodes. More...
 
Standard_Integer NbNodes () const
 Returns the number of nodes for this triangulation. More...
 
Standard_Integer NbTriangles () const
 Returns the number of triangles for this triangulation. More...
 
Standard_Boolean HasUVNodes () const
 Returns Standard_True if 2D nodes are associated with 3D nodes for this triangulation. More...
 
const TColgp_Array1OfPntNodes () const
 Returns the table of 3D nodes (3D points) for this triangulation. More...
 
TColgp_Array1OfPntChangeNodes ()
 Returns the table of 3D nodes (3D points) for this triangulation. The returned array is shared. Therefore if the table is selected by reference, you can, by simply modifying it, directly modify the data structure of this triangulation. More...
 
const gp_PntNode (const Standard_Integer theIndex) const
 Returns node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes. More...
 
gp_PntChangeNode (const Standard_Integer theIndex)
 Give access to the node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes. More...
 
const TColgp_Array1OfPnt2dUVNodes () const
 Returns the table of 2D nodes (2D points) associated with each 3D node of this triangulation. The function HasUVNodes checks if 2D nodes are associated with the 3D nodes of this triangulation. Const reference on the 2d nodes values. More...
 
TColgp_Array1OfPnt2dChangeUVNodes ()
 Returns the table of 2D nodes (2D points) associated with each 3D node of this triangulation. Function ChangeUVNodes shares the returned array. Therefore if the table is selected by reference, you can, by simply modifying it, directly modify the data structure of this triangulation. More...
 
const gp_Pnt2dUVNode (const Standard_Integer theIndex) const
 Returns UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes. More...
 
gp_Pnt2dChangeUVNode (const Standard_Integer theIndex)
 Give access to the UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes. More...
 
const Poly_Array1OfTriangleTriangles () const
 Returns the table of triangles for this triangulation. More...
 
Poly_Array1OfTriangleChangeTriangles ()
 Returns the table of triangles for this triangulation. Function ChangeUVNodes shares the returned array. Therefore if the table is selected by reference, you can, by simply modifying it, directly modify the data structure of this triangulation. More...
 
const Poly_TriangleTriangle (const Standard_Integer theIndex) const
 Returns triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles. More...
 
Poly_TriangleChangeTriangle (const Standard_Integer theIndex)
 Give access to the triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles. More...
 
void SetNormals (const Handle< TShort_HArray1OfShortReal > &theNormals)
 Sets the table of node normals. raises exception if length of theNormals != 3*NbNodes. More...
 
const TShort_Array1OfShortRealNormals () const
 Returns the table of node normals. More...
 
TShort_Array1OfShortRealChangeNormals ()
 Gives access to the table of node normals. More...
 
Standard_Boolean HasNormals () const
 Returns Standard_True if nodal normals are defined. More...
 
gp_Dir Normal (const Standard_Integer theIndex) const
 
void SetNormal (const Standard_Integer theIndex, const gp_Dir &theNormal)
 Changes normal at the given index. Raises Standard_OutOfRange exception. 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_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...
 

Protected Attributes

Standard_Real myDeflection
 
TColgp_Array1OfPnt myNodes
 
Handle< TColgp_HArray1OfPnt2d > myUVNodes
 
Poly_Array1OfTriangle myTriangles
 
Handle< TShort_HArray1OfShortReal > myNormals
 

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

Provides a triangulation for a surface, a set of surfaces, or more generally a shape. A triangulation consists of an approximate representation of the actual shape, using a collection of points and triangles. The points are located on the surface. The edges of the triangles connect adjacent points with a straight line that approximates the true curve on the surface. A triangulation comprises:

Constructor & Destructor Documentation

◆ Poly_Triangulation() [1/4]

Poly_Triangulation::Poly_Triangulation ( const Standard_Integer  nbNodes,
const Standard_Integer  nbTriangles,
const Standard_Boolean  UVNodes 
)

Constructs a triangulation from a set of triangles. The triangulation is initialized without a triangle or a node, but capable of containing nbNodes nodes, and nbTriangles triangles. Here the UVNodes flag indicates whether 2D nodes will be associated with 3D ones, (i.e. to enable a 2D representation).

◆ Poly_Triangulation() [2/4]

Poly_Triangulation::Poly_Triangulation ( const TColgp_Array1OfPnt Nodes,
const Poly_Array1OfTriangle Triangles 
)

Constructs a triangulation from a set of triangles. The triangulation is initialized with 3D points from Nodes and triangles from Triangles.

◆ Poly_Triangulation() [3/4]

Poly_Triangulation::Poly_Triangulation ( const TColgp_Array1OfPnt Nodes,
const TColgp_Array1OfPnt2d UVNodes,
const Poly_Array1OfTriangle Triangles 
)

Constructs a triangulation from a set of triangles. The triangulation is initialized with 3D points from Nodes, 2D points from UVNodes and triangles from Triangles, where coordinates of a 2D point from UVNodes are the (u, v) parameters of the corresponding 3D point from Nodes on the surface approximated by the constructed triangulation.

◆ Poly_Triangulation() [4/4]

Poly_Triangulation::Poly_Triangulation ( const Handle< Poly_Triangulation > &  theTriangulation)

Copy constructor for triangulation.

Member Function Documentation

◆ ChangeNode()

gp_Pnt& Poly_Triangulation::ChangeNode ( const Standard_Integer  theIndex)

Give access to the node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

◆ ChangeNodes()

TColgp_Array1OfPnt& Poly_Triangulation::ChangeNodes ( )
inline

Returns the table of 3D nodes (3D points) for this triangulation. The returned array is shared. Therefore if the table is selected by reference, you can, by simply modifying it, directly modify the data structure of this triangulation.

◆ ChangeNormals()

TShort_Array1OfShortReal& Poly_Triangulation::ChangeNormals ( )

Gives access to the table of node normals.

◆ ChangeTriangle()

Poly_Triangle& Poly_Triangulation::ChangeTriangle ( const Standard_Integer  theIndex)

Give access to the triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles.

◆ ChangeTriangles()

Poly_Array1OfTriangle& Poly_Triangulation::ChangeTriangles ( )
inline

Returns the table of triangles for this triangulation. Function ChangeUVNodes shares the returned array. Therefore if the table is selected by reference, you can, by simply modifying it, directly modify the data structure of this triangulation.

◆ ChangeUVNode()

gp_Pnt2d& Poly_Triangulation::ChangeUVNode ( const Standard_Integer  theIndex)

Give access to the UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

◆ ChangeUVNodes()

TColgp_Array1OfPnt2d& Poly_Triangulation::ChangeUVNodes ( )
inline

Returns the table of 2D nodes (2D points) associated with each 3D node of this triangulation. Function ChangeUVNodes shares the returned array. Therefore if the table is selected by reference, you can, by simply modifying it, directly modify the data structure of this triangulation.

◆ Copy()

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

Creates full copy of current triangulation.

◆ Deflection() [1/2]

Standard_Real Poly_Triangulation::Deflection ( ) const
inline

Returns the deflection of this triangulation.

◆ Deflection() [2/2]

void Poly_Triangulation::Deflection ( const Standard_Real  theDeflection)

Sets the deflection of this triangulation to theDeflection. See more on deflection in Polygon2D.

◆ DumpJson()

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

Dumps the content of me into the stream.

◆ HasNormals()

Standard_Boolean Poly_Triangulation::HasNormals ( ) const

Returns Standard_True if nodal normals are defined.

◆ HasUVNodes()

Standard_Boolean Poly_Triangulation::HasUVNodes ( ) const
inline

Returns Standard_True if 2D nodes are associated with 3D nodes for this triangulation.

◆ NbNodes()

Standard_Integer Poly_Triangulation::NbNodes ( ) const
inline

Returns the number of nodes for this triangulation.

◆ NbTriangles()

Standard_Integer Poly_Triangulation::NbTriangles ( ) const
inline

Returns the number of triangles for this triangulation.

◆ Node()

const gp_Pnt& Poly_Triangulation::Node ( const Standard_Integer  theIndex) const

Returns node at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

◆ Nodes()

const TColgp_Array1OfPnt& Poly_Triangulation::Nodes ( ) const
inline

Returns the table of 3D nodes (3D points) for this triangulation.

◆ Normal()

gp_Dir Poly_Triangulation::Normal ( const Standard_Integer  theIndex) const
Returns
normal at the given index. Raises Standard_OutOfRange exception.

◆ Normals()

const TShort_Array1OfShortReal& Poly_Triangulation::Normals ( ) const

Returns the table of node normals.

◆ RemoveUVNodes()

void Poly_Triangulation::RemoveUVNodes ( )

Deallocates the UV nodes.

◆ SetNormal()

void Poly_Triangulation::SetNormal ( const Standard_Integer  theIndex,
const gp_Dir theNormal 
)

Changes normal at the given index. Raises Standard_OutOfRange exception.

◆ SetNormals()

void Poly_Triangulation::SetNormals ( const Handle< TShort_HArray1OfShortReal > &  theNormals)

Sets the table of node normals. raises exception if length of theNormals != 3*NbNodes.

◆ Triangle()

const Poly_Triangle& Poly_Triangulation::Triangle ( const Standard_Integer  theIndex) const

Returns triangle at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbTriangles.

◆ Triangles()

const Poly_Array1OfTriangle& Poly_Triangulation::Triangles ( ) const
inline

Returns the table of triangles for this triangulation.

◆ UVNode()

const gp_Pnt2d& Poly_Triangulation::UVNode ( const Standard_Integer  theIndex) const

Returns UVNode at the given index. Raises Standard_OutOfRange exception if theIndex is less than 1 or greater than NbNodes.

◆ UVNodes()

const TColgp_Array1OfPnt2d& Poly_Triangulation::UVNodes ( ) const
inline

Returns the table of 2D nodes (2D points) associated with each 3D node of this triangulation. The function HasUVNodes checks if 2D nodes are associated with the 3D nodes of this triangulation. Const reference on the 2d nodes values.

Field Documentation

◆ myDeflection

Standard_Real Poly_Triangulation::myDeflection
protected

◆ myNodes

TColgp_Array1OfPnt Poly_Triangulation::myNodes
protected

◆ myNormals

Handle< TShort_HArray1OfShortReal > Poly_Triangulation::myNormals
protected

◆ myTriangles

Poly_Array1OfTriangle Poly_Triangulation::myTriangles
protected

◆ myUVNodes

Handle< TColgp_HArray1OfPnt2d > Poly_Triangulation::myUVNodes
protected

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