projection.h

Go to the documentation of this file.

/* Copyright (c) 2008-2022 the MRtrix3 contributors.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Covered Software is provided under this License on an "as is"
 * basis, without warranty of any kind, either expressed, implied, or
 * statutory, including, without limitation, warranties that the
 * Covered Software is free of defects, merchantable, fit for a
 * particular purpose or non-infringing.
 * See the Mozilla Public License v. 2.0 for more details.
 *
 * For more details, see http://www.mrtrix.org/.
 */
 
#ifndef __gui_projection_h__
#define __gui_projection_h__
 
#include "gui/gui.h"
#include "gui/crosshair.h"
#include "gui/opengl/gl.h"
#include "gui/opengl/font.h"
#include "gui/opengl/transformation.h"
 
namespace MR
{
  namespace GUI
  {
 
    const int TopEdge = 0x00000001;
    const int BottomEdge = 0x00000002;
    const int LeftEdge = 0x00000004;
    const int RightEdge = 0x00000008;
 
 
    class ModelViewProjection
    { NOMEMALIGN
      public:
        void set_viewport (int x, int y, int w, int h) {
          viewport[0] = x;
          viewport[1] = y;
          viewport[2] = w;
          viewport[3] = h;
        }
 
        void set (const GL::mat4& modelview, const GL::mat4& projection) {
          MV = modelview;
          P = projection;
          MVP = P * MV;
 
          iMV = GL::inv (MV);
          iP = GL::inv (P);
          iMVP = iMV * iP;
        }
 
        GLint x_position () const {
          return viewport[0];
        }
 
        GLint y_position () const {
          return viewport[1];
        }
 
        GLint width () const {
          return viewport[2];
        }
 
        GLint height () const {
          return viewport[3];
        }
 
        float depth_of (const Eigen::Vector3f& x) const {
          float d = MVP(2,0)*x[0] + MVP(2,1)*x[1] + MVP(2,2)*x[2] + MVP(2,3);
          if (MVP(3,2)) d /= MVP(3,0)*x[0] + MVP(3,1)*x[1] + MVP(3,2)*x[2] + MVP(3,3);
          return d;
        }
 
        Eigen::Vector3f model_to_screen (const Eigen::Vector3f& x) const {
          Eigen::Vector3f S (
              MVP(0,0)*x[0] + MVP(0,1)*x[1] + MVP(0,2)*x[2] + MVP(0,3),
              MVP(1,0)*x[0] + MVP(1,1)*x[1] + MVP(1,2)*x[2] + MVP(1,3),
              MVP(2,0)*x[0] + MVP(2,1)*x[1] + MVP(2,2)*x[2] + MVP(2,3));
          if (MVP(3,2))
            S /= MVP(3,0)*x[0] + MVP(3,1)*x[1] + MVP(3,2)*x[2] + MVP(3,3);
          S[0] = viewport[0] + 0.5f*viewport[2]*(1.0f+S[0]);
          S[1] = viewport[1] + 0.5f*viewport[3]*(1.0f+S[1]);
          return S;
        }
 
        Eigen::Vector3f model_to_screen_direction (const Eigen::Vector3f& dir) const {
          Eigen::Vector3f S (
              MVP(0,0)*dir[0] + MVP(0,1)*dir[1] + MVP(0,2)*dir[2],
              MVP(1,0)*dir[0] + MVP(1,1)*dir[1] + MVP(1,2)*dir[2],
              MVP(2,0)*dir[0] + MVP(2,1)*dir[1] + MVP(2,2)*dir[2]);
          S[0] *= 0.5f*viewport[2];
          S[1] *= 0.5f*viewport[3];
          return S;
        }
 
        Eigen::Vector3f screen_to_model (float x, float y, float depth) const {
          x = 2.0f*(x-viewport[0])/viewport[2] - 1.0f;
          y = 2.0f*(y-viewport[1])/viewport[3] - 1.0f;
          Eigen::Vector3f S (
              iMVP(0,0)*x + iMVP(0,1)*y + iMVP(0,2)*depth + iMVP(0,3),
              iMVP(1,0)*x + iMVP(1,1)*y + iMVP(1,2)*depth + iMVP(1,3),
              iMVP(2,0)*x + iMVP(2,1)*y + iMVP(2,2)*depth + iMVP(2,3));
          if (MVP(3,2))
            S /= iMVP(3,0)*x + iMVP(3,1)*y + iMVP(3,2)*depth + iMVP(3,3);
          return S;
        }
 
        Eigen::Vector3f screen_to_model (const Eigen::Vector3f& x) const {
          return screen_to_model (x[0], x[1], x[2]);
        }
 
        Eigen::Vector3f screen_to_model (const Eigen::Vector3f& x, float depth) const {
          return screen_to_model (x[0], x[1], depth);
        }
 
        Eigen::Vector3f screen_to_model (const Eigen::Vector3f& x, const Eigen::Vector3f& depth) const {
          return screen_to_model (x, depth_of (depth));
        }
 
        Eigen::Vector3f screen_to_model (const QPoint& x, float depth) const {
          return screen_to_model (x.x(), x.y(), depth);
        }
 
        Eigen::Vector3f screen_to_model (const QPoint& x, const Eigen::Vector3f& depth) const {
          return screen_to_model (x, depth_of (depth));
        }
 
        Eigen::Vector3f screen_normal () const {
          return Eigen::Vector3f (iMVP(0,2), iMVP(1,2), iMVP(2,2)).normalized().eval();
        }
 
        Eigen::Vector3f screen_to_model_direction (float x, float y, float depth) const {
          x *= 2.0f/viewport[2];
          y *= 2.0f/viewport[3];
          Eigen::Vector3f S (iMVP(0,0)*x + iMVP(0,1)*y, iMVP(1,0)*x + iMVP(1,1)*y, iMVP(2,0)*x + iMVP(2,1)*y);
          if (MVP(3,2))
            S /= iMVP(3,2)*depth + iMVP(3,3);
          return S;
        }
 
        Eigen::Vector3f screen_to_model_direction (const Eigen::Vector3f& dx, float x) const {
          return screen_to_model_direction (dx[0], dx[1], x);
        }
 
        Eigen::Vector3f screen_to_model_direction (const Eigen::Vector3f& dx, const Eigen::Vector3f& x) const {
          return screen_to_model_direction (dx, depth_of (x));
        }
 
        Eigen::Vector3f screen_to_model_direction (const QPoint& dx, float x) const {
          return screen_to_model_direction (dx.x(), dx.y(), x);
        }
 
        Eigen::Vector3f screen_to_model_direction (const QPoint& dx, const Eigen::Vector3f& x) const {
          return screen_to_model_direction (dx, depth_of (x));
        }
 
      protected:
        GL::mat4 MV, iMV, P, iP, MVP, iMVP;
        GLint viewport[4];
    };
 
 
 
 
 
 
    class Projection : public ModelViewProjection
    { NOMEMALIGN
      public:
        Projection (GL::Area* parent, const GL::Font& font) :
            glarea (parent),
            font (font),
            crosshair (new Crosshair()) { }
 
        void set_viewport (const QWidget& frame, int x, int y, int w, int h) {
          ModelViewProjection::set_viewport (x, y, w, h);
          set_viewport (frame);
        }
 
#if QT_VERSION >= 0x050100
        void set_viewport (const QWidget& frame) const {
          int m = frame.window()->devicePixelRatio();
          gl::Viewport (m*viewport[0], m*viewport[1], m*viewport[2], m*viewport[3]);
        }
#else
        void set_viewport (const QWidget&) const {
          gl::Viewport (viewport[0], viewport[1], viewport[2], viewport[3]);
        }
#endif
 
        void render_crosshairs (const Eigen::Vector3f& focus) const { crosshair->render (focus, *this); }
 
        void setup_render_text (float red = 1.0, float green = 1.0, float blue = 0.0) const {
          font.start (width(), height(), red, green, blue);
        }
        void done_render_text () const { font.stop(); }
 
        void render_text (int x, int y, const std::string& text) const {
          font.render (text, x, y);
        }
 
        void render_text_align (int x, int y, const std::string& text, int halign = 0, int valign = 0) const {
          QString s (qstr(text));
          #if QT_VERSION < QT_VERSION_CHECK(5, 11, 0)
          int w = font.metric.width (s);
          #else
          int w = font.metric.horizontalAdvance (s);
          #endif
          int h = font.metric.height();
          if (halign == 0) x -= w/2;
          else if (halign > 0) x -= w;
          if (valign == 0) y -= h/2;
          else if (valign > 0) y -= h;
          render_text (x, y, text);
        }
 
        void render_text_inset (int x, int y, const std::string& text, int inset = -1) const {
          QString s (qstr(text));
          if (inset < 0)
            inset = font.metric.height() / 2;
          if (x < inset)
            x = inset;
          #if QT_VERSION < QT_VERSION_CHECK(5, 11, 0)
          if (x + font.metric.width (s) + inset > width())
            x = width() - font.metric.width (s) - inset;
          #else
          if (x + font.metric.horizontalAdvance (s) + inset > width())
            x = width() - font.metric.horizontalAdvance (s) - inset;
          #endif
 
          if (y < inset)
            y = inset;
          if (y + font.metric.height() + inset > height())
            y = height() - font.metric.height() - inset;
          render_text (x, y, text);
        }
 
        void render_text (const std::string& text, int position, int line = 0) const {
          QString s (qstr(text));
          int x, y;
 
          #if QT_VERSION < QT_VERSION_CHECK(5, 11, 0)
          if (position & RightEdge) x = width() - font.metric.height() / 2 - font.metric.width (s);
          else if (position & LeftEdge) x = font.metric.height() / 2;
          else x = (width() - font.metric.width (s)) / 2;
          #else
          if (position & RightEdge) x = width() - font.metric.height() / 2 - font.metric.horizontalAdvance (s);
          else if (position & LeftEdge) x = font.metric.height() / 2;
          else x = (width() - font.metric.horizontalAdvance (s)) / 2;
          #endif
 
          if (position & TopEdge) y = height() - 1.5 * font.metric.height() - line * font.metric.lineSpacing();
          else if (position & BottomEdge) y = font.metric.height() / 2 + line * font.metric.lineSpacing();
          else y = (height() - font.metric.height()) / 2 - line * font.metric.lineSpacing();
 
          render_text (x, y, text);
        }
 
        void draw_orientation_labels () const;
 
 
        const GL::mat4& modelview_projection () const { return MVP; }
        const GL::mat4& modelview_projection_inverse () const { return iMVP; }
        const GL::mat4& modelview () const { return MV; }
        const GL::mat4& modelview_inverse () const { return iMV; }
        const GL::mat4& projection () const { return P; }
        const GL::mat4& projection_inverse () const { return iP; }
 
 
        using ModelViewProjection::set;
 
        void set (GL::Shader::Program& shader_program) const {
          assert (shader_program != 0);
          gl::UniformMatrix4fv (gl::GetUniformLocation (shader_program, "MVP"), 1, gl::FALSE_, modelview_projection());
        }
 
      protected:
        GL::Area* glarea;
        const GL::Font& font;
        std::shared_ptr<Crosshair> crosshair;
    };
 
 
 
 
  }
}
 
#endif