stage/include/ost/geom/vec2.hh

Go to the documentation of this file.

//------------------------------------------------------------------------------
// This file is part of the OpenStructure project <www.openstructure.org>
//
// Copyright (C) 2008-2010 by the OpenStructure authors
//
// This library 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.0 of the License, or (at your option)
// any later version.
// This library 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 library; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//------------------------------------------------------------------------------
#ifndef GEOM_VEC2_H
#define GEOM_VEC2_H

#include <cstddef> // for size_t
#include <ostream>

#include <boost/operators.hpp>

#include <ost/geom/module_config.hh>
#include <ost/config.hh>

namespace geom {

// fw decl
class Vec3;
class Vec4;

/*
  Two dimensional vector class, using Real precision.
*/
class DLLEXPORT_OST_GEOM Vec2:
    private boost::equality_comparable<Vec2>,
    private boost::additive<Vec2>,
    private boost::additive<Vec2, Real>,
    private boost::multiplicative<Vec2, Real>
{
public:
  Vec2();

  Vec2(Real x, Real y);

  Vec2(const Vec2& v);

  explicit Vec2(const Vec3& v);

  explicit Vec2(const Vec4& v);

  explicit Vec2(const Real[2]);

#if OST_DOUBLE_PRECISION
  explicit Vec2(const float[2]);
#endif
  Vec2& operator=(const Vec2& v);

  Real& operator[](std::size_t indx);
  const Real& operator[](std::size_t indx) const;
  Real GetX() const;
  Real GetY() const;
  void SetX(Real v);
  void SetY(Real v);

  bool operator==(const Vec2& rhs) const;

  Vec2& operator+=(const Vec2& rhs);
  Vec2& operator+=(Real d);
  Vec2& operator-=(const Vec2& rhs);
  Vec2& operator-=(Real d);
  Vec2 operator-() const;
  Vec2& operator*=(Real d);
  Vec2& operator/=(Real d);

  Real* Data() {return data_;}
  const Real* Data() const {return data_;}

private:
  Real data_[2];

  void set(Real x, Real y);
};

DLLEXPORT_OST_GEOM Vec2 operator/(Real d, const Vec2& v);

DLLEXPORT_OST_GEOM std::ostream& operator<<(std::ostream&, const Vec2&);

} // namespace geom

# endif

---