View.h

/*
Hyperspace Explorer - visualizing higher-dimensional geometry
Copyright (C) 2008-2010  Lene Preuss <lene.preuss@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*/

#ifndef VIEW_H
#define VIEW_H 1

#include "ParameterMap.h"

#include <vector>

class Displayable;
class Light;
namespace VecMath {
  template <typename T, unsigned D> class MultiDimensionalVector;
}

namespace UI {


class View {

  class FunctionNotSupportedException: public std::runtime_error {
  public:
    FunctionNotSupportedException(const std::string &what): std::runtime_error(what) { }
  };

public:

  View() { }
  virtual ~View() { }

  virtual const std::shared_ptr<Displayable> &F() const = 0;

  virtual void setF(Displayable *f) = 0;


  template <typename T>
  void setParameter(const std::string &parmName, const T &value) {
    ApplyChanges(ParameterMap(parmName, value));
  }


  virtual void applyTransform(const VecMath::Rotation<4> &R,
                              const VecMath::Vector<4> &T) = 0;

  virtual const VecMath::Rotation<4> &getdR() = 0;

  virtual void setdR(const VecMath::Rotation<4> &_dr) = 0;

  virtual void setNumFrames(unsigned _numFrames) = 0;
  virtual void setNumLoops(unsigned _numLoops) = 0;

  virtual void animate() = 0;

  virtual void setSize(unsigned, unsigned) = 0;

  virtual const std::string &getImgDir() = 0;
  virtual void setImgDir(const std::string &) = 0;

  virtual const std::string &getImgPrefix() = 0;
  virtual void setImgPrefix(const std::string &) = 0;

  virtual void setBackground(const Color &) = 0;
  virtual const Color &getBackground() = 0;

  virtual void addLight(Light *) = 0;
  virtual void removeLight(std::vector<Light *>::iterator) = 0;

  virtual const std::vector<Light *> &getLights() = 0;

  virtual bool getColors() const = 0;
  virtual void setColors(bool) = 0;

  virtual bool getCoordinates() const = 0;
  virtual void setCoordinates(bool) = 0;

  virtual bool getFog() const = 0;
  virtual void setFog(bool) = 0;

  virtual bool getHyperfog() const = 0;
  virtual void setHyperfog(bool) = 0;

  virtual bool getLighting() const = 0;
  virtual void setLighting(bool) = 0;

  virtual bool getShading() const = 0;
  virtual void setShading(bool) = 0;

  virtual bool getSolid() const = 0;

  virtual void setSolid(bool on) = 0;

  virtual bool getTransparence() const = 0;
  virtual void setTransparence(bool) = 0;


  virtual void drawVertex(const VecMath::Vector< 4 > &x, const VecMath::Vector< 3 > &xscr) = 0;

  virtual void drawLine(const VecMath::Vector< 4 > &x0, const VecMath::Vector< 4 > &x1,
                        const VecMath::Vector< 3 > &xscr0, const VecMath::Vector< 3 > &xscr1) = 0;
  virtual void drawTriangle(const VecMath::Vector< 4 > &x0, const VecMath::Vector< 4 > &x1,
                            const VecMath::Vector< 4 > &x2,
                            const VecMath::Vector< 3 > &xscr0, const VecMath::Vector< 3 > &xscr1,
                            const VecMath::Vector< 3 > &xscr2) = 0;
  virtual void drawQuadrangle(const VecMath::Vector< 4 > &x0, const VecMath::Vector< 4 > &x1,
                              const VecMath::Vector< 4 > &x2, const VecMath::Vector< 4 > &x3,
                              const VecMath::Vector< 3 > &xscr0, const VecMath::Vector< 3 > &xscr1,
                              const VecMath::Vector< 3 > &xscr2, const VecMath::Vector< 3 > &xscr3) = 0;
  virtual void drawPolygon(const std::vector< VecMath::Vector< 4 > > &x0,
                            const std::vector< VecMath::Vector< 3 > > &xscr0) = 0;

  virtual void drawCube(const VecMath::MultiDimensionalVector< VecMath::Vector<4>, 3 > &X,
                        unsigned t, unsigned u, unsigned v,
                        const VecMath::Vector<3> &v0, const VecMath::Vector<3> &v1,
                        const VecMath::Vector<3> &v2, const VecMath::Vector<3> &v3,
                        const VecMath::Vector<3> &v4, const VecMath::Vector<3> &v5,
                        const VecMath::Vector<3> &v6, const VecMath::Vector<3> &v7) = 0;

  virtual void commitDraw() = 0;

protected:

  virtual void ApplyChanges(const ParameterMap &) = 0;

  virtual unsigned getNumFrames() = 0;
  virtual unsigned getNumLoops() = 0;

  virtual bool getWriteImages() = 0;
  virtual void setWriteImages(bool) = 0;

  virtual void setDefaultBackground() = 0;

};

}

#endif