include/opencascade/Poly_Triangle.hxx

0001 // Created on: 1995-03-06
0002 // Created by: Laurent PAINNOT
0003 // Copyright (c) 1995-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Poly_Triangle_HeaderFile
0018 #define _Poly_Triangle_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023 #include <Standard_Integer.hxx>
0024 #include <Standard_OutOfRange.hxx>
0025
0026 //! Describes a component triangle of a triangulation (Poly_Triangulation object).
0027 //! A Triangle is defined by a triplet of nodes within [1, Poly_Triangulation::NbNodes()] range.
0028 //! Each node is an index in the table of nodes specific to an existing
0029 //! triangulation of a shape, and represents a point on the surface.
0030 class Poly_Triangle
0031 {
0032 public:
0033
0034   DEFINE_STANDARD_ALLOC
0035
0036   //! Constructs a triangle and sets all indices to zero.
0037   Poly_Triangle() { myNodes[0] =  myNodes[1] = myNodes[2] = 0; }
0038
0039   //! Constructs a triangle and sets its three indices,
0040   //! where these node values are indices in the table of nodes specific to an existing triangulation of a shape.
0041   Poly_Triangle (const Standard_Integer theN1, const Standard_Integer theN2, const Standard_Integer theN3)
0042   {
0043     myNodes[0] = theN1;
0044     myNodes[1] = theN2;
0045     myNodes[2] = theN3;
0046   }
0047
0048   //! Sets the value of the three nodes of this triangle.
0049   void Set (const Standard_Integer theN1, const Standard_Integer theN2, const Standard_Integer theN3)
0050   {
0051     myNodes[0] = theN1;
0052     myNodes[1] = theN2;
0053     myNodes[2] = theN3;
0054   }
0055
0056   //! Sets the value of node with specified index of this triangle.
0057   //! Raises Standard_OutOfRange if index is not in 1,2,3
0058   void Set (const Standard_Integer theIndex, const Standard_Integer theNode)
0059   {
0060     Standard_OutOfRange_Raise_if(theIndex < 1 || theIndex > 3, "Poly_Triangle::Set(), invalid index");
0061     myNodes[theIndex - 1] = theNode;
0062   }
0063
0064   //! Returns the node indices of this triangle.
0065   void Get (Standard_Integer& theN1, Standard_Integer& theN2, Standard_Integer& theN3) const
0066   {
0067     theN1 = myNodes[0];
0068     theN2 = myNodes[1];
0069     theN3 = myNodes[2];
0070   }
0071
0072   //! Get the node of given Index.
0073   //! Raises OutOfRange from Standard if Index is not in 1,2,3
0074   Standard_Integer Value (const Standard_Integer theIndex) const
0075   {
0076     Standard_OutOfRange_Raise_if(theIndex < 1 || theIndex > 3, "Poly_Triangle::Value(), invalid index");
0077     return myNodes[theIndex - 1];
0078   }
0079
0080   Standard_Integer operator() (const Standard_Integer Index) const { return Value(Index); }
0081
0082   //! Get the node of given Index.
0083   //! Raises OutOfRange if Index is not in 1,2,3
0084   Standard_Integer& ChangeValue (const Standard_Integer theIndex)
0085   {
0086     Standard_OutOfRange_Raise_if(theIndex < 1 || theIndex > 3, "Poly_Triangle::ChangeValue(), invalid index");
0087     return myNodes[theIndex - 1];
0088   }
0089
0090   Standard_Integer& operator() (const Standard_Integer Index) { return ChangeValue(Index); }
0091
0092 protected:
0093
0094   Standard_Integer myNodes[3];
0095
0096 };
0097
0098 #endif // _Poly_Triangle_HeaderFile