src/Graphic3d/Graphic3d_ArrayOfQuadrangleStrips.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_ArrayOfQuadrangleStrips_HeaderFile
  16 #define _Graphic3d_ArrayOfQuadrangleStrips_HeaderFile
  17
  18 #include <Graphic3d_ArrayOfPrimitives.hxx>
  19
  20 //! Contains quadrangles strip array definition.
  21 //! WARNING! Quadrangle primitives might be unsupported by graphics library.
  22 //! Triangulation should be used instead of quads for better compatibility.
  23 class Graphic3d_ArrayOfQuadrangleStrips : public Graphic3d_ArrayOfPrimitives
  24 {
  25   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfQuadrangleStrips, Graphic3d_ArrayOfPrimitives)
  26 public:
  27
  28   //! Creates an array of quadrangle strips (Graphic3d_TOPA_QUADRANGLESTRIPS), a polygon can be filled as:
  29   //! 1) Creating a single strip defined with his vertexes, i.e:
  30   //! @code
  31   //!   myArray = Graphic3d_ArrayOfQuadrangleStrips (7);
  32   //!   myArray->AddVertex (x1, y1, z1);
  33   //!   ....
  34   //!   myArray->AddVertex (x7, y7, z7);
  35   //! @endcode
  36   //! 2) Creating separate strips defined with a predefined number of strips and the number of vertex per strip, i.e:
  37   //! @code
  38   //!   myArray = Graphic3d_ArrayOfQuadrangleStrips (8, 2);
  39   //!   myArray->AddBound (4);
  40   //!   myArray->AddVertex (x1, y1, z1);
  41   //!   ....
  42   //!   myArray->AddVertex (x4, y4, z4);
  43   //!   myArray->AddBound (4);
  44   //!   myArray->AddVertex (x5, y5, z5);
  45   //!   ....
  46   //!   myArray->AddVertex (x8, y8, z8);
  47   //! @endcode
  48   //! The number of quadrangle really drawn is: VertexNumber()/2 - Min(1, BoundNumber()).
  49   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
  50   //! @param theMaxStrips  defines the maximum allowed strip  number in the array
  51   //! @param theArrayFlags array flags
  52   Graphic3d_ArrayOfQuadrangleStrips (Standard_Integer theMaxVertexs,
  53                                      Standard_Integer theMaxStrips,
  54                                      Graphic3d_ArrayFlags theArrayFlags)
  55   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_QUADRANGLESTRIPS, theMaxVertexs, theMaxStrips, 0, theArrayFlags) {}
  56
  57   //! Creates an array of quadrangle strips (Graphic3d_TOPA_QUADRANGLESTRIPS).
  58   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
  59   //! @param theMaxStrips  defines the maximum allowed strip  number in the array
  60   Graphic3d_ArrayOfQuadrangleStrips (Standard_Integer theMaxVertexs,
  61                                      Standard_Integer theMaxStrips   = 0,
  62                                      Standard_Boolean theHasVNormals = Standard_False,
  63                                      Standard_Boolean theHasVColors  = Standard_False,
  64                                      Standard_Boolean theHasSColors  = Standard_False,
  65                                      Standard_Boolean theHasVTexels  = Standard_False)
  66   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_QUADRANGLESTRIPS, theMaxVertexs, theMaxStrips, 0,
  67                                  (theHasVNormals ? Graphic3d_ArrayFlags_VertexNormal : Graphic3d_ArrayFlags_None)
  68                                | (theHasVColors  ? Graphic3d_ArrayFlags_VertexColor  : Graphic3d_ArrayFlags_None)
  69                                | (theHasVTexels  ? Graphic3d_ArrayFlags_VertexTexel  : Graphic3d_ArrayFlags_None)
  70                                | (theHasSColors  ? Graphic3d_ArrayFlags_BoundColor   : Graphic3d_ArrayFlags_None)) {}
  71
  72
  73
  74 };
  75
  76 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfQuadrangleStrips, Graphic3d_ArrayOfPrimitives)
  77
  78 #endif // _Graphic3d_ArrayOfQuadrangleStrips_HeaderFile