include/opencascade/Graphic3d_ArrayOfTriangles.hxx

0001 // Created on: 2001-01-04
0002 // Copyright (c) 2001-2014 OPEN CASCADE SAS
0003 //
0004 // This file is part of Open CASCADE Technology software library.
0005 //
0006 // This library is free software; you can redistribute it and/or modify it under
0007 // the terms of the GNU Lesser General Public License version 2.1 as published
0008 // by the Free Software Foundation, with special exception defined in the file
0009 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0010 // distribution for complete text of the license and disclaimer of any warranty.
0011 //
0012 // Alternatively, this file may be used under the terms of Open CASCADE
0013 // commercial license or contractual agreement.
0014
0015 #ifndef _Graphic3d_ArrayOfTriangles_HeaderFile
0016 #define _Graphic3d_ArrayOfTriangles_HeaderFile
0017
0018 #include <Graphic3d_ArrayOfPrimitives.hxx>
0019
0020 //! Contains triangles array definition
0021 class Graphic3d_ArrayOfTriangles : public Graphic3d_ArrayOfPrimitives
0022 {
0023   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfTriangles, Graphic3d_ArrayOfPrimitives)
0024 public:
0025
0026   //! Creates an array of triangles (Graphic3d_TOPA_TRIANGLES), a triangle can be filled as:
0027   //! 1) Creating a set of triangles defined with his vertexes, i.e:
0028   //! @code
0029   //!   myArray = Graphic3d_ArrayOfTriangles (6);
0030   //!   myArray->AddVertex (x1, y1, z1);
0031   //!   ....
0032   //!   myArray->AddVertex (x6, y6, z6);
0033   //! @endcode
0034   //! 3) Creating a set of indexed triangles defined with his vertex and edges, i.e:
0035   //! @code
0036   //!   myArray = Graphic3d_ArrayOfTriangles (4, 6);
0037   //!   myArray->AddVertex (x1, y1, z1);
0038   //!   ....
0039   //!   myArray->AddVertex (x4, y4, z4);
0040   //!   myArray->AddEdges (1, 2, 3);
0041   //!   myArray->AddEdges (2, 3, 4);
0042   //! @endcode
0043   //! @param theMaxVertexs  defines the maximum allowed vertex number in the array
0044   //! @param theMaxEdges    defines the maximum allowed edge   number in the array
0045   //! @param theArrayFlags array flags
0046   Graphic3d_ArrayOfTriangles (Standard_Integer theMaxVertexs,
0047                               Standard_Integer theMaxEdges,
0048                               Graphic3d_ArrayFlags theArrayFlags)
0049   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLES, theMaxVertexs, 0, theMaxEdges, theArrayFlags) {}
0050
0051   //! Creates an array of triangles (Graphic3d_TOPA_TRIANGLES).
0052   //! @param theMaxVertexs  defines the maximum allowed vertex number in the array
0053   //! @param theMaxEdges    defines the maximum allowed edge   number in the array
0054   //! @param theHasVNormals when TRUE,  AddVertex(Point,Normal), AddVertex(Point,Normal,Color) or AddVertex(Point,Normal,Texel) should be used to specify vertex normal;
0055   //!                       vertex normals should be specified coherent to triangle orientation (defined by order of vertexes within triangle) for proper rendering
0056   //! @param theHasVColors  when TRUE,  AddVertex(Point,Color) or AddVertex(Point,Normal,Color) should be used to specify vertex color
0057   //! @param theHasVTexels  when TRUE,  AddVertex(Point,Texel) or AddVertex(Point,Normal,Texel) should be used to specify vertex UV coordinates
0058   Graphic3d_ArrayOfTriangles (Standard_Integer theMaxVertexs,
0059                               Standard_Integer theMaxEdges    = 0,
0060                               Standard_Boolean theHasVNormals = Standard_False,
0061                               Standard_Boolean theHasVColors  = Standard_False,
0062                               Standard_Boolean theHasVTexels  = Standard_False)
0063   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLES, theMaxVertexs, 0, theMaxEdges,
0064                                  (theHasVNormals ? Graphic3d_ArrayFlags_VertexNormal : Graphic3d_ArrayFlags_None)
0065                                | (theHasVColors  ? Graphic3d_ArrayFlags_VertexColor  : Graphic3d_ArrayFlags_None)
0066                                | (theHasVTexels  ? Graphic3d_ArrayFlags_VertexTexel  : Graphic3d_ArrayFlags_None)) {}
0067
0068 };
0069
0070 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfTriangles, Graphic3d_ArrayOfPrimitives)
0071
0072 #endif // _Graphic3d_ArrayOfTriangles_HeaderFile