include/opencascade/Graphic3d_ArrayOfQuadrangles.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_ArrayOfQuadrangles_HeaderFile
0016 #define _Graphic3d_ArrayOfQuadrangles_HeaderFile
0017
0018 #include <Graphic3d_ArrayOfPrimitives.hxx>
0019
0020 //! Contains quadrangles array definition.
0021 //! WARNING! Quadrangle primitives might be unsupported by graphics library.
0022 //! Triangulation should be used instead of quads for better compatibility.
0023 class Graphic3d_ArrayOfQuadrangles : public Graphic3d_ArrayOfPrimitives
0024 {
0025   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfQuadrangles, Graphic3d_ArrayOfPrimitives)
0026 public:
0027
0028   //! Creates an array of quadrangles (Graphic3d_TOPA_QUADRANGLES), a quadrangle can be filled as:
0029   //! 1) Creating a set of quadrangles defined with his vertexes, i.e:
0030   //! @code
0031   //!   myArray = Graphic3d_ArrayOfQuadrangles (8);
0032   //!   myArray->AddVertex (x1, y1, z1);
0033   //!   ....
0034   //!   myArray->AddVertex (x8, y8, z8);
0035   //! @endcode
0036   //! 2) Creating a set of indexed quadrangles defined with his vertex ans edges, i.e:
0037   //! @code
0038   //!   myArray = Graphic3d_ArrayOfQuadrangles (6, 8);
0039   //!   myArray->AddVertex (x1, y1, z1);
0040   //!   ....
0041   //!   myArray->AddVertex (x6, y6, z6);
0042   //!   myArray->AddEdges (1, 2, 3, 4);
0043   //!   myArray->AddEdges (3, 4, 5, 6);
0044   //! @endcode
0045   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
0046   //! @param theMaxEdges   defines the maximum allowed edge   number in the array (for indexed array)
0047   //! @param theArrayFlags array flags
0048   Graphic3d_ArrayOfQuadrangles (Standard_Integer theMaxVertexs,
0049                                 Standard_Integer theMaxEdges,
0050                                 Graphic3d_ArrayFlags theArrayFlags)
0051   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_QUADRANGLES, theMaxVertexs, 0, theMaxEdges, theArrayFlags) {}
0052
0053   //! Creates an array of quadrangles (Graphic3d_TOPA_QUADRANGLES).
0054   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
0055   //! @param theMaxEdges   defines the maximum allowed edge   number in the array (for indexed array)
0056   Graphic3d_ArrayOfQuadrangles (Standard_Integer theMaxVertexs,
0057                                 Standard_Integer theMaxEdges    = 0,
0058                                 Standard_Boolean theHasVNormals = Standard_False,
0059                                 Standard_Boolean theHasVColors  = Standard_False,
0060                                 Standard_Boolean theHasVTexels  = Standard_False)
0061   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_QUADRANGLES, theMaxVertexs, 0, theMaxEdges,
0062                                  (theHasVNormals ? Graphic3d_ArrayFlags_VertexNormal : Graphic3d_ArrayFlags_None)
0063                                | (theHasVColors  ? Graphic3d_ArrayFlags_VertexColor  : Graphic3d_ArrayFlags_None)
0064                                | (theHasVTexels  ? Graphic3d_ArrayFlags_VertexTexel  : Graphic3d_ArrayFlags_None)) {}
0065
0066 };
0067
0068 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfQuadrangles, Graphic3d_ArrayOfPrimitives)
0069
0070 #endif // _Graphic3d_ArrayOfQuadrangles_HeaderFile