src/Graphic3d/Graphic3d_ArrayOfPolygons.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_ArrayOfPolygons_HeaderFile
  16 #define _Graphic3d_ArrayOfPolygons_HeaderFile
  17
  18 #include <Graphic3d_ArrayOfPrimitives.hxx>
  19
  20 //! Contains polygons array definition.
  21 //! WARNING! Polygon primitives might be unsupported by graphics library.
  22 //! Triangulation should be used instead of quads for better compatibility.
  23 class Graphic3d_ArrayOfPolygons : public Graphic3d_ArrayOfPrimitives
  24 {
  25   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfPolygons, Graphic3d_ArrayOfPrimitives)
  26 public:
  27
  28   //! Creates an array of polygons (Graphic3d_TOPA_POLYGONS), a polygon can be filled as:
  29   //! 1) Creating a single polygon defined with his vertexes, i.e:
  30   //! @code
  31   //!   myArray = Graphic3d_ArrayOfPolygons (7);
  32   //!   myArray->AddVertex (x1, y1, z1);
  33   //!   ....
  34   //!   myArray->AddVertex (x7, y7, z7);
  35   //! @endcode
  36   //! 2) Creating separate polygons defined with a predefined number of bounds and the number of vertex per bound, i.e:
  37   //! @code
  38   //!   myArray = Graphic3d_ArrayOfPolygons (7, 2);
  39   //!   myArray->AddBound (4);
  40   //!   myArray->AddVertex (x1, y1, z1);
  41   //!   ....
  42   //!   myArray->AddVertex (x4, y4, z4);
  43   //!   myArray->AddBound (3);
  44   //!   myArray->AddVertex (x5, y5, z5);
  45   //!   ....
  46   //!   myArray->AddVertex (x7, y7, z7);
  47   //! @endcode
  48   //! 3) Creating a single indexed polygon defined with his vertex ans edges, i.e:
  49   //! @code
  50   //!   myArray = Graphic3d_ArrayOfPolygons (4, 0, 6);
  51   //!   myArray->AddVertex (x1, y1, z1);
  52   //!   ....
  53   //!   myArray->AddVertex (x4, y4, z4);
  54   //!   myArray->AddEdge (1);
  55   //!   myArray->AddEdge (2);
  56   //!   myArray->AddEdge (3);
  57   //!   myArray->AddEdge (1);
  58   //!   myArray->AddEdge (2);
  59   //!   myArray->AddEdge (4);
  60   //! @endcode
  61   //! 4) Creating separate polygons defined with a predefined number of bounds and the number of edges per bound, i.e:
  62   //! @code
  63   //!   myArray = Graphic3d_ArrayOfPolygons (6, 4, 14);
  64   //!   myArray->AddBound (3);
  65   //!   myArray->AddVertex (x1, y1, z1);
  66   //!   myArray->AddVertex (x2, y2, z2);
  67   //!   myArray->AddVertex (x3, y3, z3);
  68   //!   myArray->AddEdge (1);
  69   //!   myArray->AddEdge (2);
  70   //!   myArray->AddEdge (3);
  71   //!   myArray->AddBound (3);
  72   //!   myArray->AddVertex (x4, y4, z4);
  73   //!   myArray->AddVertex (x5, y5, z5);
  74   //!   myArray->AddVertex (x6, y6, z6);
  75   //!   myArray->AddEdge (4);
  76   //!   myArray->AddEdge (5);
  77   //!   myArray->AddEdge (6);
  78   //!   myArray->AddBound (4);
  79   //!   myArray->AddEdge (2);
  80   //!   myArray->AddEdge (3);
  81   //!   myArray->AddEdge (5);
  82   //!   myArray->AddEdge (6);
  83   //!   myArray->AddBound (4);
  84   //!   myArray->AddEdge (1);
  85   //!   myArray->AddEdge (3);
  86   //!   myArray->AddEdge (5);
  87   //!   myArray->AddEdge (4);
  88   //! @endcode
  89   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
  90   //! @param theMaxBounds  defines the maximum allowed bound  number in the array
  91   //! @param theMaxEdges   defines the maximum allowed edge   number in the array
  92   //! @param theArrayFlags array flags
  93   Graphic3d_ArrayOfPolygons (Standard_Integer theMaxVertexs,
  94                              Standard_Integer theMaxBounds,
  95                              Standard_Integer theMaxEdges,
  96                              Graphic3d_ArrayFlags theArrayFlags)
  97   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_POLYGONS, theMaxVertexs, theMaxBounds, theMaxEdges, theArrayFlags) {}
  98
  99   //! Creates an array of polygons (Graphic3d_TOPA_POLYGONS):
 100   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
 101   //! @param theMaxBounds  defines the maximum allowed bound  number in the array
 102   //! @param theMaxEdges   defines the maximum allowed edge   number in the array
 103   Graphic3d_ArrayOfPolygons (const Standard_Integer theMaxVertexs,
 104                              const Standard_Integer theMaxBounds   = 0,
 105                              const Standard_Integer theMaxEdges    = 0,
 106                              const Standard_Boolean theHasVNormals = Standard_False,
 107                              const Standard_Boolean theHasVColors  = Standard_False,
 108                              const Standard_Boolean theHasBColors  = Standard_False,
 109                              const Standard_Boolean theHasVTexels  = Standard_False)
 110   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_POLYGONS, theMaxVertexs, theMaxBounds, theMaxEdges,
 111                                  (theHasVNormals ? Graphic3d_ArrayFlags_VertexNormal : Graphic3d_ArrayFlags_None)
 112                                | (theHasVColors  ? Graphic3d_ArrayFlags_VertexColor  : Graphic3d_ArrayFlags_None)
 113                                | (theHasBColors  ? Graphic3d_ArrayFlags_BoundColor   : Graphic3d_ArrayFlags_None)
 114                                | (theHasVTexels  ? Graphic3d_ArrayFlags_VertexTexel  : Graphic3d_ArrayFlags_None)) {}
 115
 116 };
 117
 118 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfPolygons, Graphic3d_ArrayOfPrimitives)
 119
 120 #endif // _Graphic3d_ArrayOfPolygons_HeaderFile