include/opencascade/Graphic3d_ArrayOfTriangleFans.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_ArrayOfTriangleFans_HeaderFile
0016 #define _Graphic3d_ArrayOfTriangleFans_HeaderFile
0017
0018 #include <Graphic3d_ArrayOfPrimitives.hxx>
0019
0020 //! Contains triangles fan array definition
0021 class Graphic3d_ArrayOfTriangleFans : public Graphic3d_ArrayOfPrimitives
0022 {
0023   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfTriangleFans, Graphic3d_ArrayOfPrimitives)
0024 public:
0025
0026   //! Creates an array of triangle fans (Graphic3d_TOPA_TRIANGLEFANS), a polygon can be filled as:
0027   //! 1) Creating a single fan defined with his vertexes, i.e:
0028   //! @code
0029   //!   myArray = Graphic3d_ArrayOfTriangleFans (7);
0030   //!   myArray->AddVertex (x1, y1, z1);
0031   //!   ....
0032   //!   myArray->AddVertex (x7, y7, z7);
0033   //! @endcode
0034   //! 2) creating separate fans defined with a predefined number of fans and the number of vertex per fan, i.e:
0035   //! @code
0036   //!   myArray = Graphic3d_ArrayOfTriangleFans (8, 2);
0037   //!   myArray->AddBound (4);
0038   //!   myArray->AddVertex (x1, y1, z1);
0039   //!   ....
0040   //!   myArray->AddVertex (x4, y4, z4);
0041   //!   myArray->AddBound (4);
0042   //!   myArray->AddVertex (x5, y5, z5);
0043   //!   ....
0044   //!   myArray->AddVertex (x8, y8, z8);
0045   //! @endcode
0046   //! The number of triangle really drawn is: VertexNumber() - 2 * Min(1, BoundNumber())
0047   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
0048   //! @param theMaxFans    defines the maximum allowed fan    number in the array
0049   //! @param theArrayFlags array flags
0050   Graphic3d_ArrayOfTriangleFans (Standard_Integer theMaxVertexs,
0051                                  Standard_Integer theMaxFans,
0052                                  Graphic3d_ArrayFlags theArrayFlags)
0053   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLEFANS, theMaxVertexs, theMaxFans, 0, theArrayFlags) {}
0054
0055   //! Creates an array of triangle fans (Graphic3d_TOPA_TRIANGLEFANS).
0056   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
0057   //! @param theMaxFans    defines the maximum allowed fan    number in the array
0058   Graphic3d_ArrayOfTriangleFans (Standard_Integer theMaxVertexs,
0059                                  Standard_Integer theMaxFans     = 0,
0060                                  Standard_Boolean theHasVNormals = Standard_False,
0061                                  Standard_Boolean theHasVColors  = Standard_False,
0062                                  Standard_Boolean theHasBColors  = Standard_False,
0063                                  Standard_Boolean theHasVTexels  = Standard_False)
0064   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_TRIANGLEFANS, theMaxVertexs, theMaxFans, 0,
0065                                  (theHasVNormals ? Graphic3d_ArrayFlags_VertexNormal : Graphic3d_ArrayFlags_None)
0066                                | (theHasVColors  ? Graphic3d_ArrayFlags_VertexColor  : Graphic3d_ArrayFlags_None)
0067                                | (theHasVTexels  ? Graphic3d_ArrayFlags_VertexTexel  : Graphic3d_ArrayFlags_None)
0068                                | (theHasBColors  ? Graphic3d_ArrayFlags_BoundColor   : Graphic3d_ArrayFlags_None)) {}
0069
0070 };
0071
0072 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfTriangleFans, Graphic3d_ArrayOfPrimitives)
0073
0074 #endif // _Graphic3d_ArrayOfTriangleFans_HeaderFile