Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / surfMesh / surfaceFormats / stl / STLtriangle.H
blobad46dccc6916459497e1de87d8a2874bd3d394a2
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend is free software: you can redistribute it and/or modify it
12     under the terms of the GNU General Public License as published by the
13     Free Software Foundation, either version 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::STLtriangle
27 Description
28     A triangle representation for STL files.
30 SourceFiles
31     STLtriangleI.H
33 \*---------------------------------------------------------------------------*/
35 #ifndef STLtriangle_H
36 #define STLtriangle_H
38 #include "STLpoint.H"
39 #include "Istream.H"
40 #include "Ostream.H"
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 namespace Foam
47 /*---------------------------------------------------------------------------*\
48                          Class STLtriangle Declaration
49 \*---------------------------------------------------------------------------*/
51 class STLtriangle
53     // Private data
55         //- Attribute is 16-bit
56         typedef unsigned short STLattrib;
58         //- The face normal, many programs write zore or other junk
59         STLpoint normal_;
61         //- The three points defining the triangle
62         STLpoint a_, b_, c_;
64         //- The attribute information could for colour or solid id, etc
65         STLattrib attrib_;
68 public:
70     // Constructors
72         //- Construct null
73         inline STLtriangle();
75         //- Construct from components
76         inline STLtriangle
77         (
78             const STLpoint& normal,
79             const STLpoint& a,
80             const STLpoint& b,
81             const STLpoint& c,
82             unsigned short attrib
83         );
85         //- Construct from istream (read binary)
86         inline STLtriangle(istream&);
89     // Member Functions
91         // Access
93             inline const STLpoint& normal() const;
94             inline const STLpoint& a() const;
95             inline const STLpoint& b() const;
96             inline const STLpoint& c() const;
97             inline unsigned short attrib() const;
100         // Read
102             //- Read from istream (binary)
103             inline void read(istream&);
106         // Write
108             //- Write to ostream (binary)
109             inline void write(ostream&);
112     // Ostream operator
114         inline friend Ostream& operator<<(Ostream&, const STLtriangle&);
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 } // End namespace Foam
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 #include "STLtriangleI.H"
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 #endif
130 // ************************************************************************* //