OCCT

// Created on: 1995-03-06
// Created by: Laurent PAINNOT
// Copyright (c) 1995-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Poly_Triangle_HeaderFile
#define _Poly_Triangle_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>
#include <Standard_Integer.hxx>
#include <Standard_OutOfRange.hxx>

//! Describes a component triangle of a triangulation (Poly_Triangulation object).
//! A Triangle is defined by a triplet of nodes within [1, Poly_Triangulation::NbNodes()] range.
//! Each node is an index in the table of nodes specific to an existing
//! triangulation of a shape, and represents a point on the surface.
class Poly_Triangle
{
public:
  DEFINE_STANDARD_ALLOC

  //! Constructs a triangle and sets all indices to zero.
  Poly_Triangle() { myNodes[0] = myNodes[1] = myNodes[2] = 0; }

  //! Constructs a triangle and sets its three indices,
  //! where these node values are indices in the table of nodes specific to an existing
  //! triangulation of a shape.
  Poly_Triangle(const int theN1, const int theN2, const int theN3)
  {
    myNodes[0] = theN1;
    myNodes[1] = theN2;
    myNodes[2] = theN3;
  }

  //! Sets the value of the three nodes of this triangle.
  void Set(const int theN1, const int theN2, const int theN3)
  {
    myNodes[0] = theN1;
    myNodes[1] = theN2;
    myNodes[2] = theN3;
  }

  //! Sets the value of node with specified index of this triangle.
  //! Raises Standard_OutOfRange if index is not in 1,2,3
  void Set(const int theIndex, const int theNode)
  {
    Standard_OutOfRange_Raise_if(theIndex < 1 || theIndex > 3,
                                 "Poly_Triangle::Set(), invalid index");
    myNodes[theIndex - 1] = theNode;
  }

  //! Returns the node indices of this triangle.
  void Get(int& theN1, int& theN2, int& theN3) const
  {
    theN1 = myNodes[0];
    theN2 = myNodes[1];
    theN3 = myNodes[2];
  }

  //! Get the node of given Index.
  //! Raises OutOfRange from Standard if Index is not in 1,2,3
  int Value(const int theIndex) const
  {
    Standard_OutOfRange_Raise_if(theIndex < 1 || theIndex > 3,
                                 "Poly_Triangle::Value(), invalid index");
    return myNodes[theIndex - 1];
  }

  int operator()(const int Index) const { return Value(Index); }

  //! Get the node of given Index.
  //! Raises OutOfRange if Index is not in 1,2,3
  int& ChangeValue(const int theIndex)
  {
    Standard_OutOfRange_Raise_if(theIndex < 1 || theIndex > 3,
                                 "Poly_Triangle::ChangeValue(), invalid index");
    return myNodes[theIndex - 1];
  }

  int& operator()(const int Index) { return ChangeValue(Index); }

protected:
  int myNodes[3];
};

#endif // _Poly_Triangle_HeaderFile