0027860: Visualization - clean up Transformation Persistence API
[occt.git] / src / Graphic3d / Graphic3d_ArrayOfTriangles.hxx
CommitLineData
42cf5bc1 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_ArrayOfTriangles_HeaderFile
16#define _Graphic3d_ArrayOfTriangles_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
26class Graphic3d_ArrayOfTriangles;
27DEFINE_STANDARD_HANDLE(Graphic3d_ArrayOfTriangles, Graphic3d_ArrayOfPrimitives)
28
29//! Contains triangles array definition
30class Graphic3d_ArrayOfTriangles : public Graphic3d_ArrayOfPrimitives
31{
32
33public:
34
35
36 //! Creates an array of triangles,
37 //! a triangle can be filled as:
38 //! 1) creating a set of triangles defined with his vertexs.
39 //! i.e:
40 //! myArray = Graphic3d_ArrayOfTriangles(6)
41 //! myArray->AddVertex(x1,y1,z1)
42 //! ....
43 //! myArray->AddVertex(x6,y6,z6)
44 //! 3) creating a set of indexed triangles defined with his vertex
45 //! ans edges.
46 //! i.e:
47 //! myArray = Graphic3d_ArrayOfTriangles(4,6)
48 //! myArray->AddVertex(x1,y1,z1)
49 //! ....
50 //! myArray->AddVertex(x4,y4,z4)
51 //! myArray->AddEdge(1)
52 //! myArray->AddEdge(2)
53 //! myArray->AddEdge(3)
54 //! myArray->AddEdge(2)
55 //! myArray->AddEdge(3)
56 //! myArray->AddEdge(4)
57 //!
58 //! <maxVertexs> defined the maximun allowed vertex number in the array.
59 //! <maxEdges> defined the maximun allowed edge number in the array.
60 //! Warning:
61 //! When <hasVNormals> is TRUE , you must use one of
62 //! AddVertex(Point,Normal)
63 //! or AddVertex(Point,Normal,Color)
64 //! or AddVertex(Point,Normal,Texel) methods.
65 //! When <hasVColors> is TRUE , you must use one of
66 //! AddVertex(Point,Color)
67 //! or AddVertex(Point,Normal,Color) methods.
68 //! When <hasTexels> is TRUE , you must use one of
69 //! AddVertex(Point,Texel)
70 //! or AddVertex(Point,Normal,Texel) methods.
71 //! Warning:
72 //! the user is responsible about the orientation of the triangle
73 //! depending of the order of the created vertex or edges and this
74 //! orientation must be coherent with the vertex normal optionnaly
75 //! given at each vertex (See the Orientate() methods).
76 Standard_EXPORT Graphic3d_ArrayOfTriangles(const Standard_Integer maxVertexs, const Standard_Integer maxEdges = 0, const Standard_Boolean hasVNormals = Standard_False, const Standard_Boolean hasVColors = Standard_False, const Standard_Boolean hasTexels = Standard_False);
77
78
79
80
92efcf78 81 DEFINE_STANDARD_RTTIEXT(Graphic3d_ArrayOfTriangles,Graphic3d_ArrayOfPrimitives)
42cf5bc1 82
83protected:
84
85
86
87
88private:
89
90
91
92
93};
94
95
96
97
98
99
100
101#endif // _Graphic3d_ArrayOfTriangles_HeaderFile