include/opencascade/Graphic3d_ArrayOfSegments.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_ArrayOfSegments_HeaderFile
0016 #define _Graphic3d_ArrayOfSegments_HeaderFile
0017
0018 #include <Graphic3d_ArrayOfPrimitives.hxx>
0019
0020 //! Contains segments array definition.
0021 class Graphic3d_ArrayOfSegments : public Graphic3d_ArrayOfPrimitives
0022 {
0023   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfSegments, Graphic3d_ArrayOfPrimitives)
0024 public:
0025   //! Creates an array of segments (Graphic3d_TOPA_SEGMENTS), a segment can be filled as:
0026   //! 1) Creating a set of segments defined with his vertexes, i.e:
0027   //! @code
0028   //!   myArray = Graphic3d_ArrayOfSegments (4);
0029   //!   myArray->AddVertex (x1, y1, z1);
0030   //!   ....
0031   //!   myArray->AddVertex (x4, y4, z4);
0032   //! @endcode
0033   //! 2) Creating a set of indexed segments defined with his vertex and edges, i.e:
0034   //! @code
0035   //!   myArray = Graphic3d_ArrayOfSegments (4, 8);
0036   //!   myArray->AddVertex (x1, y1, z1);
0037   //!   ....
0038   //!   myArray->AddVertex (x4, y4, z4);
0039   //!   myArray->AddEdges (1, 2);
0040   //!   myArray->AddEdges (3, 4);
0041   //!   myArray->AddEdges (2, 4);
0042   //!   myArray->AddEdges (1, 3);
0043   //! @endcode
0044   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
0045   //! @param theMaxEdges   defines the maximum allowed edge   number in the array
0046   //! @param theArrayFlags array flags
0047   Graphic3d_ArrayOfSegments(int theMaxVertexs, int theMaxEdges, Graphic3d_ArrayFlags theArrayFlags)
0048       : Graphic3d_ArrayOfPrimitives(Graphic3d_TOPA_SEGMENTS,
0049                                     theMaxVertexs,
0050                                     0,
0051                                     theMaxEdges,
0052                                     theArrayFlags)
0053   {
0054   }
0055
0056   //! Creates an array of segments (Graphic3d_TOPA_SEGMENTS).
0057   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
0058   //! @param theMaxEdges   defines the maximum allowed edge   number in the array
0059   //! @param theHasVColors when TRUE, AddVertex(Point,Color) should be used for specifying vertex
0060   //! color
0061   Graphic3d_ArrayOfSegments(int theMaxVertexs, int theMaxEdges = 0, bool theHasVColors = false)
0062       : Graphic3d_ArrayOfPrimitives(Graphic3d_TOPA_SEGMENTS,
0063                                     theMaxVertexs,
0064                                     0,
0065                                     theMaxEdges,
0066                                     theHasVColors ? Graphic3d_ArrayFlags_VertexColor
0067                                                   : Graphic3d_ArrayFlags_None)
0068   {
0069   }
0070 };
0071
0072 #endif // _Graphic3d_ArrayOfSegments_HeaderFile