src/Graphic3d/Graphic3d_ArrayOfTriangleFans.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_ArrayOfTriangleFans_HeaderFile
  16 #define _Graphic3d_ArrayOfTriangleFans_HeaderFile
  17
  18 #include <Graphic3d_ArrayOfPrimitives.hxx>
  19
  20 //! Contains triangles fan array definition
  21 class Graphic3d_ArrayOfTriangleFans : public Graphic3d_ArrayOfPrimitives
  22 {
  23   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfTriangleFans, Graphic3d_ArrayOfPrimitives)
  24 public:
  25
  26   //! Creates an array of triangle fans, a polygon can be filled as:
  27   //! 1) Creating a single fan defined with his vertexes, i.e:
  28   //! @code
  29   //!   myArray = Graphic3d_ArrayOfTriangleFans (7);
  30   //!   myArray->AddVertex (x1, y1, z1);
  31   //!   ....
  32   //!   myArray->AddVertex (x7, y7, z7);
  33   //! @endcode
  34   //! 2) creating separate fans defined with a predefined number of fans and the number of vertex per fan, i.e:
  35   //! @code
  36   //!   myArray = Graphic3d_ArrayOfTriangleFans (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 theMaxFans    defines the maximum allowed fan    number in the array
  48   //! The number of triangle really drawn is: VertexNumber() - 2 * Min(1, BoundNumber())
  49   Graphic3d_ArrayOfTriangleFans (const Standard_Integer theMaxVertexs,
  50                                  const Standard_Integer theMaxFans     = 0,
  51                                  const Standard_Boolean theHasVNormals = Standard_False,
  52                                  const Standard_Boolean theHasVColors  = Standard_False,
  53                                  const Standard_Boolean theHasBColors  = Standard_False,
  54                                  const Standard_Boolean theHasVTexels  = Standard_False)
  55   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLEFANS, theMaxVertexs, theMaxFans, 0, theHasVNormals, theHasVColors, theHasBColors, theHasVTexels) {}
  56
  57 };
  58
  59 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfTriangleFans, Graphic3d_ArrayOfPrimitives)
  60
  61 #endif // _Graphic3d_ArrayOfTriangleFans_HeaderFile