Camera.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://visualizationlibrary.org                                                   */
/*                                                                                    */
/*  Copyright (c) 2005-2020, Michele Bosi                                             */
/*  All rights reserved.                                                              */
/*                                                                                    */
/*  Redistribution and use in source and binary forms, with or without modification,  */
/*  are permitted provided that the following conditions are met:                     */
/*                                                                                    */
/*  - Redistributions of source code must retain the above copyright notice, this     */
/*  list of conditions and the following disclaimer.                                  */
/*                                                                                    */
/*  - Redistributions in binary form must reproduce the above copyright notice, this  */
/*  list of conditions and the following disclaimer in the documentation and/or       */
/*  other materials provided with the distribution.                                   */
/*                                                                                    */
/*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND   */
/*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED     */
/*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE            */
/*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR  */
/*  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    */
/*  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;      */
/*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    */
/*  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT           */
/*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS     */
/*  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      */
/*                                                                                    */
/**************************************************************************************/

#ifndef Camera_INCLUDE_ONCE
#define Camera_INCLUDE_ONCE

#include <vlCore/checks.hpp>
#include <vlCore/math_utils.hpp>
#include <vlCore/Vector4.hpp>
#include <vlGraphics/Viewport.hpp>
#include <vlGraphics/Frustum.hpp>
#include <vlCore/Ray.hpp>

namespace vl
{
  class AABB;
  //-----------------------------------------------------------------------------
  // Camera
  //-----------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT Camera: public Object
  {
    VL_INSTRUMENT_CLASS(vl::Camera, Object)

  public:
    Camera();

    void computeNearFarOptimizedProjMatrix(const Sphere& scene_bounding_sphere);

    void computeFrustumPlanes();

    void applyModelViewMatrix(const mat4& model_matrix) const;

    void applyViewMatrix() const;

    void applyProjMatrix() const;

    real aspectRatio() const
    {
      if (viewport())
        return (real)viewport()->width()/viewport()->height();
      else
        return 0;
    }

    void setFOV(real fov) { mFOV = fov; }

    real fov() const { return mFOV; }

    void setNearPlane(real nearplane) { mNearPlane = nearplane; }

    real nearPlane() const { return mNearPlane; }

    void setFarPlane(real farplane) { mFarPlane = farplane; }

    real farPlane() const { return mFarPlane; }

    real left() const { return mLeft; }
    void setLeft(real v) { mLeft = v; }

    real right() const { return mRight; }
    void setRight(real v) { mRight = v; }

    real bottom() const { return mBottom; }
    void setBottom(real v) { mBottom = v; }

    real top() const { return mTop; }
    void setTop(real v) { mTop = v; }

    void setFrustum(const Frustum& frustum) { mFrustum = frustum; }

    const Frustum& frustum() const { return mFrustum; }

    Frustum& frustum() { return mFrustum; }

    void setViewport(Viewport* viewport) { mViewport = viewport; }

    Viewport* viewport() { return mViewport.get(); }

    const Viewport* viewport() const { return mViewport.get(); }

    void bindTransform(Transform* transform) { mBoundTransform = transform; }

    const Transform* boundTransform() const { return mBoundTransform.get(); }

    Transform* boundTransform() { return mBoundTransform.get(); }

    void setViewMatrix(const mat4& mat) { mViewMatrix = mat; mViewMatrix.getInverse(mModelingMatrix); }

    const mat4& viewMatrix() const { return mViewMatrix; }

    void setModelingMatrix(const mat4& mat) { mModelingMatrix = mat; mModelingMatrix.getInverse(mViewMatrix); }

    const mat4& modelingMatrix() const { return mModelingMatrix; }

    void setProjectionMatrix(const mat4& mat, EProjectionMatrixType proj_type) { mProjectionMatrix = mat; mProjectionType = proj_type; }

    const mat4& projectionMatrix() const { return mProjectionMatrix; }

    EProjectionMatrixType projectionMatrixType() const { return mProjectionType; }

    void setProjectionPerspective();

    void setProjectionPerspective(real fov, real near, real far);

    void setProjectionFrustum(real left, real right, real bottom, real top, real znear, real zfar);

    void setProjectionOrtho(real left, real right, real bottom, real top, real znear, real zfar);

    void setProjectionOrtho();

    void setProjectionOrtho(real offset);

    void setViewMatrixLookAt(const vec3& eye, const vec3& at, const vec3& up);

    void getViewMatrixAsLookAt(vec3& eye, vec3& at, vec3& up, vec3& right) const;

    bool project(const vec4& in_world, vec4& out_viewp) const;

    bool unproject(const vec3& in_viewp, vec4& out_world) const;

    bool unproject(std::vector<vec3>& points) const;

    Ray computeRay(int viewp_x, int viewp_y);

    Frustum computeRayFrustum(int viewp_x, int viewp_y);

    void adjustView(const AABB& aabb, const vec3& dir, const vec3& up, real bias=1.0f);

  protected:
    mat4 mViewMatrix;
    mat4 mModelingMatrix;
    mat4 mProjectionMatrix;
    ref<Viewport> mViewport;
    Frustum mFrustum;
    ref<Transform> mBoundTransform;
    real mFOV;
    real mLeft, mRight, mBottom, mTop;
    real mNearPlane;
    real mFarPlane;
    EProjectionMatrixType mProjectionType;
  };
}

#endif