bluenoise-raytracer/raytracer/nvpro_core/nvh/cameracontrol.hpp

/*
 * Copyright (c) 2014-2021, NVIDIA CORPORATION.  All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-FileCopyrightText: Copyright (c) 2014-2021 NVIDIA CORPORATION
 * SPDX-License-Identifier: Apache-2.0
 */


#ifndef NV_CAMCONTROL_INCLUDED
#define NV_CAMCONTROL_INCLUDED

#include <algorithm>
#include <glm/ext/matrix_transform.hpp>
#include <glm/gtx/euler_angles.hpp>


namespace nvh {
//////////////////////////////////////////////////////////////////////////
/** @DOC_START
    # class nvh::CameraControl

    > nvh::CameraControl is a utility class to create a viewmatrix based on mouse inputs.
  
    It can operate in perspective or orthographic mode (`m_sceneOrtho==true`).
  
    perspective:
    - LMB: rotate
    - RMB or WHEEL: zoom via dolly movement
    - MMB: pan/move within camera plane
  
    ortho:
    - LMB: pan/move within camera plane
    - RMB or WHEEL: zoom via dolly movement, application needs to use `m_sceneOrthoZoom` for projection matrix adjustment
    - MMB: rotate
  
    The camera can be orbiting (`m_useOrbit==true`) around `m_sceneOrbit` or
    otherwise provide "first person/fly through"-like controls.
  
    Speed of movement/rotation etc. is influenced by `m_sceneDimension` as well as the 
    sensitivity values.
@DOC_END  */

class CameraControl
{
public:
  CameraControl()
      : m_lastButtonFlags(0)
      , m_lastWheel(0)
      , m_senseWheelZoom(0.05f / 120.0f)
      , m_senseZoom(0.001f)
      , m_senseRotate((glm::pi<float>() * 0.5f) / 256.0f)
      , m_sensePan(1.0f)
      , m_sceneOrbit(0.0f)
      , m_sceneDimension(1.0f)
      , m_sceneOrtho(false)
      , m_sceneOrthoZoom(1.0f)
      , m_useOrbit(true)
      , m_sceneUp(0, 1, 0)
  {
  }

  inline void processActions(const glm::ivec2& window, const glm::vec2& mouse, int mouseButtonFlags, int wheel)
  {
    int changed       = m_lastButtonFlags ^ mouseButtonFlags;
    m_lastButtonFlags = mouseButtonFlags;

    int panFlag  = m_sceneOrtho ? 1 << 0 : 1 << 2;
    int zoomFlag = 1 << 1;
    int rotFlag  = m_sceneOrtho ? 1 << 2 : 1 << 0;


    m_panning      = !!(mouseButtonFlags & panFlag);
    m_zooming      = !!(mouseButtonFlags & zoomFlag);
    m_rotating     = !!(mouseButtonFlags & rotFlag);
    m_zoomingWheel = wheel != m_lastWheel;

    m_startZoomWheel = m_lastWheel;
    m_lastWheel      = wheel;

    if(m_rotating)
    {
      m_panning = false;
      m_zooming = false;
    }

    if(m_panning && (changed & panFlag))
    {
      // pan
      m_startPan    = mouse;
      m_startMatrix = m_viewMatrix;
    }
    if(m_zooming && (changed & zoomFlag))
    {
      // zoom
      m_startMatrix    = m_viewMatrix;
      m_startZoom      = mouse;
      m_startZoomOrtho = m_sceneOrthoZoom;
    }
    if(m_rotating && (changed & rotFlag))
    {
      // rotate
      m_startRotate = mouse;
      m_startMatrix = m_viewMatrix;
    }

    if(m_zooming || m_zoomingWheel)
    {
      float dist = m_zooming ? -(glm::dot(mouse - m_startZoom, glm::vec2(-1, 1)) * m_sceneDimension * m_senseZoom) :
                               (float(wheel - m_startZoomWheel) * m_sceneDimension * m_senseWheelZoom);

      if(m_zoomingWheel)
      {
        m_startZoomOrtho = m_sceneOrthoZoom;
        m_startMatrix    = m_viewMatrix;
      }

      if(m_sceneOrtho)
      {
        float newzoom = m_startZoomOrtho - (dist);
        if(m_zoomingWheel)
        {
          if(newzoom < 0)
          {
            m_sceneOrthoZoom *= 0.5;
          }
          else if(m_sceneOrthoZoom < abs(dist))
          {
            m_sceneOrthoZoom *= 2.0;
          }
          else
          {
            m_sceneOrthoZoom = newzoom;
          }
        }
        else
        {
          m_sceneOrthoZoom = newzoom;
        }
        m_sceneOrthoZoom = std::max(0.0001f, m_sceneOrthoZoom);
      }
      else
      {
        glm::mat4 delta = glm::translate(glm::mat4(1), glm::vec3(0, 0, dist * 2.0f));
        m_viewMatrix    = delta * m_startMatrix;
      }
    }

    if(m_panning)
    {
      float aspect = float(window.x) / float(window.y);

      glm::vec3 winsize(window.x, window.y, 1.0f);
      glm::vec3 ortho(m_sceneOrthoZoom * aspect, m_sceneOrthoZoom, 1.0f);
      glm::vec3 sub(mouse - m_startPan, 0.0f);
      sub /= winsize;
      sub *= ortho;
      sub.y *= -1.0;
      if(!m_sceneOrtho)
      {
        sub *= m_sensePan * m_sceneDimension;
      }

      glm::mat4 delta = glm::translate(glm::mat4(1), sub);
      m_viewMatrix    = delta * m_startMatrix;
    }

    if(m_rotating)
    {
      float aspect = float(window.x) / float(window.y);

      glm::vec2 angles = (mouse - m_startRotate) * m_senseRotate;


      if(m_useOrbit)
      {
        glm::mat4 rot    = glm::yawPitchRoll(angles.x, angles.y, 0.0f);
        glm::vec3 center = glm::vec3(m_startMatrix * glm::vec4(m_sceneOrbit, 1.0f));
        glm::mat4 delta  = glm::translate(glm::mat4(1), center) * rot * glm::translate(glm::mat4(1), -center);

        m_viewMatrix = delta * m_startMatrix;
      }
      else
      {
        // FIXME use sceneUP
        glm::mat4 rot = glm::yawPitchRoll(angles.x, angles.y, 0.0f);

        m_viewMatrix = rot * m_startMatrix;
      }
    }
  }

  bool  m_useOrbit;
  bool  m_sceneOrtho;
  float m_sceneOrthoZoom;
  float m_sceneDimension;

  glm::vec3 m_sceneUp;
  glm::vec3 m_sceneOrbit;
  glm::mat4 m_viewMatrix;

  float m_senseWheelZoom;
  float m_senseZoom;
  float m_senseRotate;
  float m_sensePan;

private:
  bool m_zooming;
  bool m_zoomingWheel;
  bool m_panning;
  bool m_rotating;

  glm::vec2 m_startPan;
  glm::vec2 m_startZoom;
  glm::vec2 m_startRotate;
  glm::mat4 m_startMatrix;
  int       m_startZoomWheel;
  float     m_startZoomOrtho;

  int m_lastButtonFlags;
  int m_lastWheel;
};
}  // namespace nvh

#endif