0030239: Visualization, Graphic3d_ArrayOfPrimitives - pass Graphic3d_ArrayFlags bitma...
[occt.git] / src / Graphic3d / Graphic3d_ArrayOfSegments.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_ArrayOfSegments_HeaderFile
16 #define _Graphic3d_ArrayOfSegments_HeaderFile
17
18 #include <Graphic3d_ArrayOfPrimitives.hxx>
19
20 //! Contains segments array definition.
21 class Graphic3d_ArrayOfSegments : public Graphic3d_ArrayOfPrimitives
22 {
23   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfSegments, Graphic3d_ArrayOfPrimitives)
24 public:
25
26   //! Creates an array of segments (Graphic3d_TOPA_SEGMENTS), a segment can be filled as:
27   //! 1) Creating a set of segments defined with his vertexes, i.e:
28   //! @code
29   //!   myArray = Graphic3d_ArrayOfSegments (4);
30   //!   myArray->AddVertex (x1, y1, z1);
31   //!   ....
32   //!   myArray->AddVertex (x4, y4, z4);
33   //! @endcode
34   //! 2) Creating a set of indexed segments defined with his vertex and edges, i.e:
35   //! @code
36   //!   myArray = Graphic3d_ArrayOfSegments (4, 8);
37   //!   myArray->AddVertex (x1, y1, z1);
38   //!   ....
39   //!   myArray->AddVertex (x4, y4, z4);
40   //!   myArray->AddEdges (1, 2);
41   //!   myArray->AddEdges (3, 4);
42   //!   myArray->AddEdges (2, 4);
43   //!   myArray->AddEdges (1, 3);
44   //! @endcode
45   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
46   //! @param theMaxEdges   defines the maximum allowed edge   number in the array
47   //! @param theArrayFlags array flags
48   Graphic3d_ArrayOfSegments (Standard_Integer theMaxVertexs,
49                              Standard_Integer theMaxEdges,
50                              Graphic3d_ArrayFlags theArrayFlags)
51   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_SEGMENTS, theMaxVertexs, 0, theMaxEdges, theArrayFlags) {}
52
53   //! Creates an array of segments (Graphic3d_TOPA_SEGMENTS).
54   //! @param theMaxVertexs defines the maximum allowed vertex number in the array
55   //! @param theMaxEdges   defines the maximum allowed edge   number in the array
56   //! @param theHasVColors when TRUE, AddVertex(Point,Color) should be used for specifying vertex color
57   Graphic3d_ArrayOfSegments (Standard_Integer theMaxVertexs,
58                              Standard_Integer theMaxEdges   = 0,
59                              Standard_Boolean theHasVColors = Standard_False)
60   : Graphic3d_ArrayOfPrimitives (Graphic3d_TOPA_SEGMENTS, theMaxVertexs, 0, theMaxEdges, theHasVColors ? Graphic3d_ArrayFlags_VertexColor : Graphic3d_ArrayFlags_None) {}
61
62
63 };
64
65 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfSegments, Graphic3d_ArrayOfPrimitives)
66
67 #endif // _Graphic3d_ArrayOfSegments_HeaderFile