vertex.hh

Go to the documentation of this file.

/*
 * lib-gmapkernel : Un noyau de 3-G-cartes et des opérations.
 * Copyright (C) 2004, Moka Team, Université de Poitiers, Laboratoire SIC
 *               http://www.sic.sp2mi.univ-poitiers.fr/
 * Copyright (C) 2009, Guillaume Damiand, CNRS, LIRIS,
 *               guillaume.damiand@liris.cnrs.fr, http://liris.cnrs.fr/
 *
 * This file is part of lib-gmapkernel
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

//******************************************************************************
#ifndef VERTEX_HH
#define VERTEX_HH
//******************************************************************************
#include "math-extension.hh"
#include "inline-macro.hh"

#include <iostream>
//******************************************************************************
class CVertex
{
private:
  TCoordinate FCoord[3];

public:
  // @name Constructeurs et destructeur
  // @{

  CVertex();

  CVertex(TCoordinate Ax, TCoordinate Ay, TCoordinate Az);

  CVertex(TCoordinate ATab[3]);

  CVertex(const CVertex& AVertex);

  ~CVertex();

  // @}
  // @name Accesseurs
  // @{

  TCoordinate getX() const;

  TCoordinate getY() const;

  TCoordinate getZ() const;

  TCoordinate getCoord(int ADim) const;

  void setX(TCoordinate ANewX);

  void setY(TCoordinate ANewY);

  void setZ(TCoordinate ANewZ);

  void setCoord(int ADim, TCoordinate ANewCoord);

  void setXYZ(TCoordinate ANewX, TCoordinate ANewY, TCoordinate ANewZ);

  // @}
  // @name Divers opérateurs
  // @{

  CVertex& operator=(const CVertex& AVertex);

  bool operator==(const CVertex& AVertex) const;
  bool operator!=(const CVertex& AVertex) const;

  CVertex& operator+=(const CVertex&);
  CVertex& operator-=(const CVertex&);

  CVertex& operator*=(TCoordinate);
  CVertex& operator/=(TCoordinate);

  CVertex  operator*(TCoordinate) const;
  CVertex  operator/(TCoordinate) const;

  CVertex  operator+(const CVertex&) const;
  CVertex  operator-(const CVertex&) const;
  CVertex  operator+(              ) const;
  CVertex  operator-(              ) const;

  // @}
  // @name Fonctions mathématiques
  // @{

  CVertex operator*(const CVertex& AVector) const;

  TCoordinate dot(const CVertex& AVector) const;

  // @}
  // @name Fonctions diverses
  // @{

  TCoordinate norm() const;

  TCoordinate normalize();

  CVertex normalized() const;

  TCoordinate sqrNorm() const;

  bool isNull() const;

  CVertex multiply(const CVertex& AVector) const;

  CVertex divide(const CVertex& AVector) const;

  // @}
};

// @name Produit d'un vecteur par une constante
// @{

CVertex operator*(TCoordinate ACoef, const CVertex& AVertex);

// @}
// @name Affichage
// @{

std::ostream& operator<<(std::ostream& AStream, const CVertex& AVertex);

// @}
// @name Constantes
// @{

static const CVertex ORIGIN(0,0,0);

static const CVertex OX(1,0,0);

static const CVertex OY(0,1,0);

static const CVertex OZ(0,0,1);

static const CVertex BASE[3] = { OX, OY, OZ };

// @}
//******************************************************************************
#include INCLUDE_INLINE("vertex.icc")
//******************************************************************************
#endif // VERTEX_HH
//******************************************************************************