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

Contains polygons array definition. WARNING! Polygon primitives might be unsupported by graphics library. Triangulation should be used instead of quads for better compatibility. More...

#include <Graphic3d_ArrayOfPolygons.hxx>

Inheritance diagram for Graphic3d_ArrayOfPolygons:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_ArrayOfPolygons (Standard_Integer theMaxVertexs, Standard_Integer theMaxBounds, Standard_Integer theMaxEdges, Graphic3d_ArrayFlags theArrayFlags)
 Creates an array of polygons (Graphic3d_TOPA_POLYGONS), a polygon can be filled as: 1) Creating a single polygon defined with his vertexes, i.e: More...
 
 Graphic3d_ArrayOfPolygons (const Standard_Integer theMaxVertexs, const Standard_Integer theMaxBounds=0, const Standard_Integer theMaxEdges=0, const Standard_Boolean theHasVNormals=Standard_False, const Standard_Boolean theHasVColors=Standard_False, const Standard_Boolean theHasBColors=Standard_False, const Standard_Boolean theHasVTexels=Standard_False)
 Creates an array of polygons (Graphic3d_TOPA_POLYGONS): More...
 
- Public Member Functions inherited from Graphic3d_ArrayOfPrimitives
virtual ~Graphic3d_ArrayOfPrimitives ()
 Destructor. More...
 
const Handle< Graphic3d_Buffer > & Attributes () const
 Returns vertex attributes buffer (colors, normals, texture coordinates). More...
 
Graphic3d_TypeOfPrimitiveArray Type () const
 Returns the type of this primitive. More...
 
Standard_CString StringType () const
 Returns the string type of this primitive. More...
 
Standard_Boolean HasVertexNormals () const
 Returns TRUE when vertex normals array is defined. More...
 
Standard_Boolean HasVertexColors () const
 Returns TRUE when vertex colors array is defined. More...
 
Standard_Boolean HasVertexTexels () const
 Returns TRUE when vertex texels array is defined. More...
 
Standard_Integer VertexNumber () const
 Returns the number of defined vertex. More...
 
Standard_Integer VertexNumberAllocated () const
 Returns the number of allocated vertex. More...
 
Standard_Integer ItemNumber () const
 Returns the number of total items according to the array type. More...
 
Standard_Boolean IsValid ()
 Returns TRUE only when the contains of this array is available. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex)
 Adds a vertice in the array. More...
 
Standard_Integer AddVertex (const Graphic3d_Vec3 &theVertex)
 Adds a vertice in the array. More...
 
Standard_Integer AddVertex (const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ)
 Adds a vertice in the array. More...
 
Standard_Integer AddVertex (const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ)
 Adds a vertice in the array. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex, const Quantity_Color &theColor)
 Adds a vertice and vertex color in the vertex array. Warning: theColor is ignored when the hasVColors constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex, const Standard_Integer theColor32)
 Adds a vertice and vertex color in the vertex array. Warning: theColor is ignored when the hasVColors constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex, const Graphic3d_Vec4ub &theColor)
 Adds a vertice and vertex color in the vertex array. Warning: theColor is ignored when the hasVColors constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex, const gp_Dir &theNormal)
 Adds a vertice and vertex normal in the vertex array. Warning: theNormal is ignored when the hasVNormals constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ, const Standard_Real theNX, const Standard_Real theNY, const Standard_Real theNZ)
 Adds a vertice and vertex normal in the vertex array. Warning: Normal is ignored when the hasVNormals constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ, const Standard_ShortReal theNX, const Standard_ShortReal theNY, const Standard_ShortReal theNZ)
 Adds a vertice and vertex normal in the vertex array. Warning: Normal is ignored when the hasVNormals constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex, const gp_Dir &theNormal, const Quantity_Color &theColor)
 Adds a vertice,vertex normal and color in the vertex array. Warning: theNormal is ignored when the hasVNormals constructor parameter is FALSE and theColor is ignored when the hasVColors constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex, const gp_Dir &theNormal, const Standard_Integer theColor32)
 Adds a vertice,vertex normal and color in the vertex array. Warning: theNormal is ignored when the hasVNormals constructor parameter is FALSE and theColor is ignored when the hasVColors constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex, const gp_Pnt2d &theTexel)
 Adds a vertice and vertex texture in the vertex array. theTexel is ignored when the hasVTexels constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ, const Standard_Real theTX, const Standard_Real theTY)
 Adds a vertice and vertex texture coordinates in the vertex array. Texel is ignored when the hasVTexels constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ, const Standard_ShortReal theTX, const Standard_ShortReal theTY)
 Adds a vertice and vertex texture coordinates in the vertex array. Texel is ignored when the hasVTexels constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const gp_Pnt &theVertex, const gp_Dir &theNormal, const gp_Pnt2d &theTexel)
 Adds a vertice,vertex normal and texture in the vertex array. Warning: theNormal is ignored when the hasVNormals constructor parameter is FALSE and theTexel is ignored when the hasVTexels constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const Standard_Real theX, const Standard_Real theY, const Standard_Real theZ, const Standard_Real theNX, const Standard_Real theNY, const Standard_Real theNZ, const Standard_Real theTX, const Standard_Real theTY)
 Adds a vertice,vertex normal and texture in the vertex array. Warning: Normal is ignored when the hasVNormals constructor parameter is FALSE and Texel is ignored when the hasVTexels constructor parameter is FALSE. More...
 
Standard_Integer AddVertex (const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ, const Standard_ShortReal theNX, const Standard_ShortReal theNY, const Standard_ShortReal theNZ, const Standard_ShortReal theTX, const Standard_ShortReal theTY)
 Adds a vertice,vertex normal and texture in the vertex array. Warning: Normal is ignored when the hasVNormals constructor parameter is FALSE and Texel is ignored when the hasVTexels constructor parameter is FALSE. More...
 
void SetVertice (const Standard_Integer theIndex, const gp_Pnt &theVertex)
 Change the vertice of rank theIndex in the array. More...
 
void SetVertice (const Standard_Integer theIndex, const Standard_ShortReal theX, const Standard_ShortReal theY, const Standard_ShortReal theZ)
 Change the vertice of rank theIndex in the array. More...
 
void SetVertexColor (const Standard_Integer theIndex, const Quantity_Color &theColor)
 Change the vertex color of rank theIndex in the array. More...
 
void SetVertexColor (const Standard_Integer theIndex, const Standard_Real theR, const Standard_Real theG, const Standard_Real theB)
 Change the vertex color of rank theIndex in the array. More...
 
void SetVertexColor (const Standard_Integer theIndex, const Graphic3d_Vec4ub &theColor)
 Change the vertex color of rank theIndex in the array. More...
 
void SetVertexColor (const Standard_Integer theIndex, const Standard_Integer theColor32)
 Change the vertex color of rank theIndex> in the array. More...
 
void SetVertexNormal (const Standard_Integer theIndex, const gp_Dir &theNormal)
 Change the vertex normal of rank theIndex in the array. More...
 
void SetVertexNormal (const Standard_Integer theIndex, const Standard_Real theNX, const Standard_Real theNY, const Standard_Real theNZ)
 Change the vertex normal of rank theIndex in the array. More...
 
void SetVertexTexel (const Standard_Integer theIndex, const gp_Pnt2d &theTexel)
 Change the vertex texel of rank theIndex in the array. More...
 
void SetVertexTexel (const Standard_Integer theIndex, const Standard_Real theTX, const Standard_Real theTY)
 Change the vertex texel of rank theIndex in the array. More...
 
gp_Pnt Vertice (const Standard_Integer theRank) const
 Returns the vertice at rank theRank from the vertex table if defined. More...
 
void Vertice (const Standard_Integer theRank, Standard_Real &theX, Standard_Real &theY, Standard_Real &theZ) const
 Returns the vertice coordinates at rank theRank from the vertex table if defined. More...
 
Quantity_Color VertexColor (const Standard_Integer theRank) const
 Returns the vertex color at rank theRank from the vertex table if defined. More...
 
void VertexColor (const Standard_Integer theIndex, Graphic3d_Vec4ub &theColor) const
 Returns the vertex color at rank theIndex from the vertex table if defined. More...
 
void VertexColor (const Standard_Integer theRank, Standard_Real &theR, Standard_Real &theG, Standard_Real &theB) const
 Returns the vertex color values at rank theRank from the vertex table if defined. More...
 
void VertexColor (const Standard_Integer theRank, Standard_Integer &theColor) const
 Returns the vertex color values at rank theRank from the vertex table if defined. More...
 
gp_Dir VertexNormal (const Standard_Integer theRank) const
 Returns the vertex normal at rank theRank from the vertex table if defined. More...
 
void VertexNormal (const Standard_Integer theRank, Standard_Real &theNX, Standard_Real &theNY, Standard_Real &theNZ) const
 Returns the vertex normal coordinates at rank theRank from the vertex table if defined. More...
 
gp_Pnt2d VertexTexel (const Standard_Integer theRank) const
 Returns the vertex texture at rank theRank from the vertex table if defined. More...
 
void VertexTexel (const Standard_Integer theRank, Standard_Real &theTX, Standard_Real &theTY) const
 Returns the vertex texture coordinates at rank theRank from the vertex table if defined. More...
 
const Handle< Graphic3d_IndexBuffer > & Indices () const
 Returns optional index buffer. More...
 
Standard_Integer EdgeNumber () const
 Returns the number of defined edges. More...
 
Standard_Integer EdgeNumberAllocated () const
 Returns the number of allocated edges. More...
 
Standard_Integer Edge (const Standard_Integer theRank) const
 Returns the vertex index at rank theRank in the range [1,EdgeNumber()]. More...
 
Standard_Integer AddEdge (const Standard_Integer theVertexIndex)
 Adds an edge in the range [1,VertexNumber()] in the array. More...
 
Standard_Integer AddEdges (Standard_Integer theVertexIndex1, Standard_Integer theVertexIndex2)
 Convenience method, adds two vertex indices (a segment) in the range [1,VertexNumber()] in the array. More...
 
Standard_Integer AddEdges (Standard_Integer theVertexIndex1, Standard_Integer theVertexIndex2, Standard_Integer theVertexIndex3)
 Convenience method, adds three vertex indices (a triangle) in the range [1,VertexNumber()] in the array. More...
 
Standard_Integer AddEdges (Standard_Integer theVertexIndex1, Standard_Integer theVertexIndex2, Standard_Integer theVertexIndex3, Standard_Integer theVertexIndex4)
 Convenience method, adds four vertex indices (a quad) in the range [1,VertexNumber()] in the array. More...
 
const Handle< Graphic3d_BoundBuffer > & Bounds () const
 Returns optional bounds buffer. More...
 
Standard_Boolean HasBoundColors () const
 Returns TRUE when bound colors array is defined. More...
 
Standard_Integer BoundNumber () const
 Returns the number of defined bounds. More...
 
Standard_Integer BoundNumberAllocated () const
 Returns the number of allocated bounds. More...
 
Standard_Integer Bound (const Standard_Integer theRank) const
 Returns the edge number at rank theRank. More...
 
Quantity_Color BoundColor (const Standard_Integer theRank) const
 Returns the bound color at rank theRank from the bound table if defined. More...
 
void BoundColor (const Standard_Integer theRank, Standard_Real &theR, Standard_Real &theG, Standard_Real &theB) const
 Returns the bound color values at rank theRank from the bound table if defined. More...
 
Standard_Integer AddBound (const Standard_Integer theEdgeNumber)
 Adds a bound of length theEdgeNumber in the bound array. More...
 
Standard_Integer AddBound (const Standard_Integer theEdgeNumber, const Quantity_Color &theBColor)
 Adds a bound of length theEdgeNumber and bound color theBColor in the bound array. Warning: theBColor is ignored when the hasBColors constructor parameter is FALSE. More...
 
Standard_Integer AddBound (const Standard_Integer theEdgeNumber, const Standard_Real theR, const Standard_Real theG, const Standard_Real theB)
 Adds a bound of length theEdgeNumber and bound color coordinates in the bound array. Warning: <theR,theG,theB> are ignored when the hasBColors constructor parameter is FALSE. More...
 
void SetBoundColor (const Standard_Integer theIndex, const Quantity_Color &theColor)
 Change the bound color of rank theIndex in the array. More...
 
void SetBoundColor (const Standard_Integer theIndex, const Standard_Real theR, const Standard_Real theG, const Standard_Real theB)
 Change the bound color of rank theIndex in the array. 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 Graphic3d_ArrayOfPrimitives
static Handle< Graphic3d_ArrayOfPrimitivesCreateArray (Graphic3d_TypeOfPrimitiveArray theType, Standard_Integer theMaxVertexs, Standard_Integer theMaxEdges, Graphic3d_ArrayFlags theArrayFlags)
 Create an array of specified type. More...
 
static Handle< Graphic3d_ArrayOfPrimitivesCreateArray (Graphic3d_TypeOfPrimitiveArray theType, Standard_Integer theMaxVertexs, Standard_Integer theMaxBounds, Standard_Integer theMaxEdges, Graphic3d_ArrayFlags theArrayFlags)
 Create an array of specified type. 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...
 
- Protected Member Functions inherited from Graphic3d_ArrayOfPrimitives
 Graphic3d_ArrayOfPrimitives (Graphic3d_TypeOfPrimitiveArray theType, Standard_Integer theMaxVertexs, Standard_Integer theMaxBounds, Standard_Integer theMaxEdges, Graphic3d_ArrayFlags theArrayFlags)
 Main constructor. More...
 
void init (Graphic3d_TypeOfPrimitiveArray theType, Standard_Integer theMaxVertexs, Standard_Integer theMaxBounds, Standard_Integer theMaxEdges, Graphic3d_ArrayFlags theArrayFlags)
 Array constructor. More...
 

Detailed Description

Contains polygons array definition. WARNING! Polygon primitives might be unsupported by graphics library. Triangulation should be used instead of quads for better compatibility.

Constructor & Destructor Documentation

◆ Graphic3d_ArrayOfPolygons() [1/2]

Graphic3d_ArrayOfPolygons::Graphic3d_ArrayOfPolygons ( Standard_Integer  theMaxVertexs,
Standard_Integer  theMaxBounds,
Standard_Integer  theMaxEdges,
Graphic3d_ArrayFlags  theArrayFlags 
)
inline

Creates an array of polygons (Graphic3d_TOPA_POLYGONS), a polygon can be filled as: 1) Creating a single polygon defined with his vertexes, i.e:

myArray->AddVertex (x1, y1, z1);
....
myArray->AddVertex (x7, y7, z7);

2) Creating separate polygons defined with a predefined number of bounds and the number of vertex per bound, i.e:

myArray = Graphic3d_ArrayOfPolygons (7, 2);
myArray->AddBound (4);
myArray->AddVertex (x1, y1, z1);
....
myArray->AddVertex (x4, y4, z4);
myArray->AddBound (3);
myArray->AddVertex (x5, y5, z5);
....
myArray->AddVertex (x7, y7, z7);

3) Creating a single indexed polygon defined with his vertex ans edges, i.e:

myArray = Graphic3d_ArrayOfPolygons (4, 0, 6);
myArray->AddVertex (x1, y1, z1);
....
myArray->AddVertex (x4, y4, z4);
myArray->AddEdge (1);
myArray->AddEdge (2);
myArray->AddEdge (3);
myArray->AddEdge (1);
myArray->AddEdge (2);
myArray->AddEdge (4);

4) Creating separate polygons defined with a predefined number of bounds and the number of edges per bound, i.e:

myArray = Graphic3d_ArrayOfPolygons (6, 4, 14);
myArray->AddBound (3);
myArray->AddVertex (x1, y1, z1);
myArray->AddVertex (x2, y2, z2);
myArray->AddVertex (x3, y3, z3);
myArray->AddEdge (1);
myArray->AddEdge (2);
myArray->AddEdge (3);
myArray->AddBound (3);
myArray->AddVertex (x4, y4, z4);
myArray->AddVertex (x5, y5, z5);
myArray->AddVertex (x6, y6, z6);
myArray->AddEdge (4);
myArray->AddEdge (5);
myArray->AddEdge (6);
myArray->AddBound (4);
myArray->AddEdge (2);
myArray->AddEdge (3);
myArray->AddEdge (5);
myArray->AddEdge (6);
myArray->AddBound (4);
myArray->AddEdge (1);
myArray->AddEdge (3);
myArray->AddEdge (5);
myArray->AddEdge (4);
Parameters
theMaxVertexsdefines the maximum allowed vertex number in the array
theMaxBoundsdefines the maximum allowed bound number in the array
theMaxEdgesdefines the maximum allowed edge number in the array
theArrayFlagsarray flags

◆ Graphic3d_ArrayOfPolygons() [2/2]

Graphic3d_ArrayOfPolygons::Graphic3d_ArrayOfPolygons ( const Standard_Integer  theMaxVertexs,
const Standard_Integer  theMaxBounds = 0,
const Standard_Integer  theMaxEdges = 0,
const Standard_Boolean  theHasVNormals = Standard_False,
const Standard_Boolean  theHasVColors = Standard_False,
const Standard_Boolean  theHasBColors = Standard_False,
const Standard_Boolean  theHasVTexels = Standard_False 
)
inline

Creates an array of polygons (Graphic3d_TOPA_POLYGONS):

Parameters
theMaxVertexsdefines the maximum allowed vertex number in the array
theMaxBoundsdefines the maximum allowed bound number in the array
theMaxEdgesdefines the maximum allowed edge number in the array

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