Merge remote-tracking branch 'origin/nr/multiSolverFix' into nextRelease
[foam-extend-3.2.git] / src / surfMesh / surfaceFormats / stl / STLtriangle.H
blob01c00f55adf00829811cde37c41b76ccfedb4e87
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright held by original author
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
11     OpenFOAM 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 2 of the License, or (at your
14     option) any later version.
16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
19     for more details.
21     You should have received a copy of the GNU General Public License
22     along with OpenFOAM; if not, write to the Free Software Foundation,
23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 Class
26     Foam::STLtriangle
28 Description
29     A triangle representation for STL files.
31 SourceFiles
32     STLtriangleI.H
34 \*---------------------------------------------------------------------------*/
36 #ifndef STLtriangle_H
37 #define STLtriangle_H
39 #include "STLpoint.H"
40 #include "Istream.H"
41 #include "Ostream.H"
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 /*---------------------------------------------------------------------------*\
49                          Class STLtriangle Declaration
50 \*---------------------------------------------------------------------------*/
52 class STLtriangle
54     // Private data
56         //- Attribute is 16-bit
57         typedef unsigned short STLattrib;
59         //- The face normal, many programs write zore or other junk
60         STLpoint normal_;
62         //- The three points defining the triangle
63         STLpoint a_, b_, c_;
65         //- The attribute information could for colour or solid id, etc
66         STLattrib attrib_;
69 public:
71     // Constructors
73         //- Construct null
74         inline STLtriangle();
76         //- Construct from components
77         inline STLtriangle
78         (
79             const STLpoint& normal,
80             const STLpoint& a,
81             const STLpoint& b,
82             const STLpoint& c,
83             unsigned short attrib
84         );
86         //- Construct from istream (read binary)
87         inline STLtriangle(istream&);
90     // Member Functions
92         // Access
94             inline const STLpoint& normal() const;
95             inline const STLpoint& a() const;
96             inline const STLpoint& b() const;
97             inline const STLpoint& c() const;
98             inline unsigned short attrib() const;
101         // Read
103             //- Read from istream (binary)
104             inline void read(istream&);
107         // Write
109             //- Write to ostream (binary)
110             inline void write(ostream&);
113     // Ostream operator
115         inline friend Ostream& operator<<(Ostream&, const STLtriangle&);
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 } // End namespace Foam
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 #include "STLtriangleI.H"
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 #endif
131 // ************************************************************************* //