0030239: Visualization, Graphic3d_ArrayOfPrimitives - pass Graphic3d_ArrayFlags bitma...
[occt.git] / src / Graphic3d / Graphic3d_ArrayOfTriangleStrips.hxx
1 // Created on: 2001-01-04
2 // Copyright (c) 2001-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _Graphic3d_ArrayOfTriangleStrips_HeaderFile
16 #define _Graphic3d_ArrayOfTriangleStrips_HeaderFile
17
18 #include <Graphic3d_ArrayOfPrimitives.hxx>
19
20 //! Contains triangles strip array definition.
21 class Graphic3d_ArrayOfTriangleStrips : public Graphic3d_ArrayOfPrimitives
22 {
23   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfTriangleStrips, Graphic3d_ArrayOfPrimitives)
24 public:
25
26   //! Creates an array of triangle strips (Graphic3d_TOPA_TRIANGLESTRIPS), a polygon can be filled as:
27   //! 1) Creating a single strip defined with his vertexes, i.e:
28   //! @code
29   //!   myArray = Graphic3d_ArrayOfTriangleStrips (7);
30   //!   myArray->AddVertex (x1, y1, z1);
31   //!   ....
32   //!   myArray->AddVertex (x7, y7, z7);
33   //! @endcode
34   //! 2) Creating separate strips defined with a predefined number of strips and the number of vertex per strip, i.e:
35   //! @code
36   //!   myArray = Graphic3d_ArrayOfTriangleStrips (8, 2);
37   //!   myArray->AddBound (4);
38   //!   myArray->AddVertex (x1, y1, z1);
39   //!   ....
40   //!   myArray->AddVertex (x4, y4, z4);
41   //!   myArray->AddBound (4);
42   //!   myArray->AddVertex (x5, y5, z5);
43   //!   ....
44   //!   myArray->AddVertex (x8, y8, z8);
45   //! @endcode
46   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
47   //! @param theMaxStrips  defines the maximum allowed strip  number in the array;
48   //!                      the number of triangle really drawn is: VertexNumber() - 2 * Min(1, BoundNumber())
49   //! @param theArrayFlags array flags
50   Graphic3d_ArrayOfTriangleStrips (Standard_Integer theMaxVertexs,
51                                    Standard_Integer theMaxStrips,
52                                    Graphic3d_ArrayFlags theArrayFlags)
53   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLESTRIPS, theMaxVertexs, theMaxStrips, 0, theArrayFlags) {}
54
55   //! Creates an array of triangle strips (Graphic3d_TOPA_TRIANGLESTRIPS).
56   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
57   //! @param theMaxStrips  defines the maximum allowed strip  number in the array;
58   //!                      the number of triangle really drawn is: VertexNumber() - 2 * Min(1, BoundNumber())
59   //! @param theHasVNormals when TRUE, AddVertex(Point,Normal), AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) should be used to specify vertex normal;
60   //!                       vertex normals should be specified coherent to triangle orientation (defined by order of vertexes within triangle) for proper rendering
61   //! @param theHasVColors  when TRUE, AddVertex(Point,Color) or AddVertex(Point,Normal,Color) should be used to specify vertex color
62   //! @param theHasBColors  when TRUE, AddBound(number,Color) should be used to specify sub-group color
63   //! @param theHasVTexels  when TRUE, AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) should be used to specify vertex UV coordinates
64   Graphic3d_ArrayOfTriangleStrips (Standard_Integer theMaxVertexs,
65                                    Standard_Integer theMaxStrips   = 0,
66                                    Standard_Boolean theHasVNormals = Standard_False,
67                                    Standard_Boolean theHasVColors  = Standard_False,
68                                    Standard_Boolean theHasBColors  = Standard_False,
69                                    Standard_Boolean theHasVTexels  = Standard_False)
70   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLESTRIPS, theMaxVertexs, theMaxStrips, 0,
71                                  (theHasVNormals ? Graphic3d_ArrayFlags_VertexNormal : Graphic3d_ArrayFlags_None)
72                                | (theHasVColors  ? Graphic3d_ArrayFlags_VertexColor  : Graphic3d_ArrayFlags_None)
73                                | (theHasVTexels  ? Graphic3d_ArrayFlags_VertexTexel  : Graphic3d_ArrayFlags_None)
74                                | (theHasBColors  ? Graphic3d_ArrayFlags_BoundColor   : Graphic3d_ArrayFlags_None)) {}
75
76 };
77
78 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfTriangleStrips, Graphic3d_ArrayOfPrimitives)
79
80 #endif // _Graphic3d_ArrayOfTriangleStrips_HeaderFile