0029074: Visualization, TKOpenGl - support Geometry Shader definition
[occt.git] / src / Graphic3d / Graphic3d_ArrayOfQuadrangleStrips.hxx
index c53cada..8f6fbac 100644 (file)
 #ifndef _Graphic3d_ArrayOfQuadrangleStrips_HeaderFile
 #define _Graphic3d_ArrayOfQuadrangleStrips_HeaderFile
 
-#include <Standard.hxx>
-#include <Standard_Type.hxx>
-
 #include <Graphic3d_ArrayOfPrimitives.hxx>
-#include <Standard_Integer.hxx>
-#include <Standard_Boolean.hxx>
-
-
-class Graphic3d_ArrayOfQuadrangleStrips;
-DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfQuadrangleStrips, Graphic3d_ArrayOfPrimitives)
 
-//! Contains quadrangles strip array definition
+//! Contains quadrangles strip array definition.
+//! WARNING! Quadrangle primitives might be unsupported by graphics library.
+//! Triangulation should be used instead of quads for better compatibility.
 class Graphic3d_ArrayOfQuadrangleStrips : public Graphic3d_ArrayOfPrimitives
 {
-
+  DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfQuadrangleStrips, Graphic3d_ArrayOfPrimitives)
 public:
 
-  
-  //! Creates an array of quadrangle strips,
-  //! a polygon can be filled as:
-  //! 1) creating a single strip defined with his vertexs.
-  //! i.e:
-  //! myArray = Graphic3d_ArrayOfQuadrangleStrips(7)
-  //! myArray->AddVertex(x1,y1,z1)
-  //! ....
-  //! myArray->AddVertex(x7,y7,z7)
-  //! 2) creating separate strips defined with a predefined
-  //! number of strips and the number of vertex per strip.
-  //! i.e:
-  //! myArray = Graphic3d_ArrayOfQuadrangleStrips(8,2)
-  //! myArray->AddBound(4)
-  //! myArray->AddVertex(x1,y1,z1)
-  //! ....
-  //! myArray->AddVertex(x4,y4,z4)
-  //! myArray->AddBound(4)
-  //! myArray->AddVertex(x5,y5,z5)
-  //! ....
-  //! myArray->AddVertex(x8,y8,z8)
-  //!
-  //! <maxVertexs> defined the maximun allowed vertex number in the array.
-  //! <maxStrips> defined the maximun allowed strip number in the array.
-  //! The number of quadrangle really drawn is :
-  //! VertexNumber()/2-Min(1,BoundNumber())
-  Standard_EXPORT Graphic3d_ArrayOfQuadrangleStrips(const Standard_Integer maxVertexs, const Standard_Integer maxStrips = 0, const Standard_Boolean hasVNormals = Standard_False, const Standard_Boolean hasVColors = Standard_False, const Standard_Boolean hasSColors = Standard_False, const Standard_Boolean hasTexels = Standard_False);
-
-
-
-
-  DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfQuadrangleStrips,Graphic3d_ArrayOfPrimitives)
-
-protected:
-
-
-
-
-private:
-
-
-
+  //! Creates an array of quadrangle strips, a polygon can be filled as:
+  //! 1) Creating a single strip defined with his vertexes, i.e:
+  //! @code
+  //!   myArray = Graphic3d_ArrayOfQuadrangleStrips (7);
+  //!   myArray->AddVertex (x1, y1, z1);
+  //!   ....
+  //!   myArray->AddVertex (x7, y7, z7);
+  //! @endcode
+  //! 2) Creating separate strips defined with a predefined number of strips and the number of vertex per strip, i.e:
+  //! @code
+  //!   myArray = Graphic3d_ArrayOfQuadrangleStrips (8, 2);
+  //!   myArray->AddBound (4);
+  //!   myArray->AddVertex (x1, y1, z1);
+  //!   ....
+  //!   myArray->AddVertex (x4, y4, z4);
+  //!   myArray->AddBound (4);
+  //!   myArray->AddVertex (x5, y5, z5);
+  //!   ....
+  //!   myArray->AddVertex (x8, y8, z8);
+  //! @endcode
+  //! @param theMaxVertexs defines the maximum allowed vertex number in the array
+  //! @param theMaxStrips  defines the maximum allowed strip  number in the array
+  //! The number of quadrangle really drawn is: VertexNumber()/2 - Min(1, BoundNumber()).
+  Graphic3d_ArrayOfQuadrangleStrips (const Standard_Integer theMaxVertexs,
+                                     const Standard_Integer theMaxStrips   = 0,
+                                     const Standard_Boolean theHasVNormals = Standard_False,
+                                     const Standard_Boolean theHasVColors  = Standard_False,
+                                     const Standard_Boolean theHasSColors  = Standard_False,
+                                     const Standard_Boolean theHasVTexels  = Standard_False)
+  : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_QUADRANGLESTRIPS, theMaxVertexs, theMaxStrips, 0, theHasVNormals, theHasVColors, theHasSColors, theHasVTexels) {}
 
 };
 
-
-
-
-
-
+DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfQuadrangleStrips, Graphic3d_ArrayOfPrimitives)
 
 #endif // _Graphic3d_ArrayOfQuadrangleStrips_HeaderFile