0030239: Visualization, Graphic3d_ArrayOfPrimitives - pass Graphic3d_ArrayFlags bitma...
[occt.git] / src / Graphic3d / Graphic3d_ArrayOfTriangles.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_ArrayOfTriangles_HeaderFile
16 #define _Graphic3d_ArrayOfTriangles_HeaderFile
17
18 #include <Graphic3d_ArrayOfPrimitives.hxx>
19
20 //! Contains triangles array definition
21 class Graphic3d_ArrayOfTriangles : public Graphic3d_ArrayOfPrimitives
22 {
23   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfTriangles, Graphic3d_ArrayOfPrimitives)
24 public:
25  
26   //! Creates an array of triangles (Graphic3d_TOPA_TRIANGLES), a triangle can be filled as:
27   //! 1) Creating a set of triangles defined with his vertexes, i.e:
28   //! @code
29   //!   myArray = Graphic3d_ArrayOfTriangles (6);
30   //!   myArray->AddVertex (x1, y1, z1);
31   //!   ....
32   //!   myArray->AddVertex (x6, y6, z6);
33   //! @endcode
34   //! 3) Creating a set of indexed triangles defined with his vertex and edges, i.e:
35   //! @code
36   //!   myArray = Graphic3d_ArrayOfTriangles (4, 6);
37   //!   myArray->AddVertex (x1, y1, z1);
38   //!   ....
39   //!   myArray->AddVertex (x4, y4, z4);
40   //!   myArray->AddEdges (1, 2, 3);
41   //!   myArray->AddEdges (2, 3, 4);
42   //! @endcode
43   //! @param theMaxVertexs  defines the maximum allowed vertex number in the array
44   //! @param theMaxEdges    defines the maximum allowed edge   number in the array
45   //! @param theArrayFlags array flags
46   Graphic3d_ArrayOfTriangles (Standard_Integer theMaxVertexs,
47                               Standard_Integer theMaxEdges,
48                               Graphic3d_ArrayFlags theArrayFlags)
49   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLES, theMaxVertexs, 0, theMaxEdges, theArrayFlags) {}
50
51   //! Creates an array of triangles (Graphic3d_TOPA_TRIANGLES).
52   //! @param theMaxVertexs  defines the maximum allowed vertex number in the array
53   //! @param theMaxEdges    defines the maximum allowed edge   number in the array
54   //! @param theHasVNormals when TRUE,  AddVertex(Point,Normal), AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) should be used to specify vertex normal;
55   //!                       vertex normals should be specified coherent to triangle orientation (defined by order of vertexes within triangle) for proper rendering
56   //! @param theHasVColors  when TRUE,  AddVertex(Point,Color) or AddVertex(Point,Normal,Color) should be used to specify vertex color
57   //! @param theHasVTexels  when TRUE,  AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) should be used to specify vertex UV coordinates
58   Graphic3d_ArrayOfTriangles (Standard_Integer theMaxVertexs,
59                               Standard_Integer theMaxEdges    = 0,
60                               Standard_Boolean theHasVNormals = Standard_False,
61                               Standard_Boolean theHasVColors  = Standard_False,
62                               Standard_Boolean theHasVTexels  = Standard_False)
63   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLES, theMaxVertexs, 0, theMaxEdges,
64                                  (theHasVNormals ? Graphic3d_ArrayFlags_VertexNormal : Graphic3d_ArrayFlags_None)
65                                | (theHasVColors  ? Graphic3d_ArrayFlags_VertexColor  : Graphic3d_ArrayFlags_None)
66                                | (theHasVTexels  ? Graphic3d_ArrayFlags_VertexTexel  : Graphic3d_ArrayFlags_None)) {}
67
68 };
69
70 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfTriangles, Graphic3d_ArrayOfPrimitives)
71
72 #endif // _Graphic3d_ArrayOfTriangles_HeaderFile