0027860: Visualization - clean up Transformation Persistence API
[occt.git] / src / Graphic3d / Graphic3d_ArrayOfPolylines.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_ArrayOfPolylines_HeaderFile
16 #define _Graphic3d_ArrayOfPolylines_HeaderFile
17
18 #include <Standard.hxx>
19 #include <Standard_Type.hxx>
20
21 #include <Graphic3d_ArrayOfPrimitives.hxx>
22 #include <Standard_Integer.hxx>
23 #include <Standard_Boolean.hxx>
24
25
26 class Graphic3d_ArrayOfPolylines;
27 DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfPolylines, Graphic3d_ArrayOfPrimitives)
28
29 //! Contains polylines array definition
30 class Graphic3d_ArrayOfPolylines : public Graphic3d_ArrayOfPrimitives
31 {
32
33 public:
34
35   
36   //! Creates an array of polylines,
37   //! a polyline can be filled as:
38   //! 1) creating a single polyline defined with his vertexs.
39   //! i.e:
40   //! myArray = Graphic3d_ArrayOfPolylines(7)
41   //! myArray->AddVertex(x1,y1,z1)
42   //! ....
43   //! myArray->AddVertex(x7,y7,z7)
44   //! 2) creating separate polylines defined with a predefined
45   //! number of bounds and the number of vertex per bound.
46   //! i.e:
47   //! myArray = Graphic3d_ArrayOfPolylines(7,2)
48   //! myArray->AddBound(4)
49   //! myArray->AddVertex(x1,y1,z1)
50   //! ....
51   //! myArray->AddVertex(x4,y4,z4)
52   //! myArray->AddBound(3)
53   //! myArray->AddVertex(x5,y5,z5)
54   //! ....
55   //! myArray->AddVertex(x7,y7,z7)
56   //! 3) creating a single indexed polyline defined with his vertex
57   //! ans edges.
58   //! i.e:
59   //! myArray = Graphic3d_ArrayOfPolylines(4,0,6)
60   //! myArray->AddVertex(x1,y1,z1)
61   //! ....
62   //! myArray->AddVertex(x4,y4,z4)
63   //! myArray->AddEdge(1)
64   //! myArray->AddEdge(2)
65   //! myArray->AddEdge(3)
66   //! myArray->AddEdge(1)
67   //! myArray->AddEdge(2)
68   //! myArray->AddEdge(4)
69   //! 4) creating separate polylines defined with a predefined
70   //! number of bounds and the number of edges per bound.
71   //! i.e:
72   //! myArray = Graphic3d_ArrayOfPolylines(6,4,14)
73   //! myArray->AddBound(3)
74   //! myArray->AddVertex(x1,y1,z1)
75   //! myArray->AddVertex(x2,y2,z2)
76   //! myArray->AddVertex(x3,y3,z3)
77   //! myArray->AddEdge(1)
78   //! myArray->AddEdge(2)
79   //! myArray->AddEdge(3)
80   //! myArray->AddBound(3)
81   //! myArray->AddVertex(x4,y4,z4)
82   //! myArray->AddVertex(x5,y5,z5)
83   //! myArray->AddVertex(x6,y6,z6)
84   //! myArray->AddEdge(4)
85   //! myArray->AddEdge(5)
86   //! myArray->AddEdge(6)
87   //! myArray->AddBound(4)
88   //! myArray->AddEdge(2)
89   //! myArray->AddEdge(3)
90   //! myArray->AddEdge(5)
91   //! myArray->AddEdge(6)
92   //! myArray->AddBound(4)
93   //! myArray->AddEdge(1)
94   //! myArray->AddEdge(3)
95   //! myArray->AddEdge(5)
96   //! myArray->AddEdge(4)
97   //!
98   //! <maxVertexs> defined the maximun allowed vertex number in the array.
99   //! <maxBounds> defined the maximun allowed bound number in the array.
100   //! <maxEdges> defined the maximun allowed edge number in the array.
101   //! Warning:
102   //! When <hasVColors> is TRUE , you must use one of
103   //! AddVertex(Point,Color)
104   //! or  AddVertex(Point,Normal,Color) methods.
105   //! When <hasBColors> is TRUE , <maxBounds> must be > 0 and
106   //! you must use the
107   //! AddBound(number,Color) method.
108   Standard_EXPORT Graphic3d_ArrayOfPolylines(const Standard_Integer maxVertexs, const Standard_Integer maxBounds = 0, const Standard_Integer maxEdges = 0, const Standard_Boolean hasVColors = Standard_False, const Standard_Boolean hasBColors = Standard_False);
109
110
111
112
113   DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfPolylines,Graphic3d_ArrayOfPrimitives)
114
115 protected:
116
117
118
119
120 private:
121
122
123
124
125 };
126
127
128
129
130
131
132
133 #endif // _Graphic3d_ArrayOfPolylines_HeaderFile