D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlGraphics/Camera.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://www.visualizationlibrary.com                                               */
/*                                                                                    */
/*  Copyright (c) 2005-2010, 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/math3D.hpp>
#include <vlCore/Vector4.hpp>
#include <vlGraphics/RenderTarget.hpp>
#include <vlGraphics/Viewport.hpp>
#include <vlGraphics/Frustum.hpp>
#include <vlCore/Ray.hpp>

namespace vl
{
  class AABB;
  //-----------------------------------------------------------------------------
  // Camera
  //-----------------------------------------------------------------------------
  class VLGRAPHICS_EXPORT Camera: public Object
  {
  public:
    virtual const char* className() { return "vl::Camera"; }

    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; }

    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 followTransform(Transform* transform) { mFollowTransform = transform; }

    const Transform* followedTransform() const { return mFollowTransform.get(); }

    Transform* followedTransform() { return mFollowTransform.get(); }

    void setViewMatrix(const mat4& mat) { mViewMatrix = mat; mInverseViewMatrix = mat; mInverseViewMatrix.invert(); }

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

    void setInverseViewMatrix(const mat4& mat) { mInverseViewMatrix = mat; mViewMatrix = mat; mViewMatrix.invert(); }

    const mat4& inverseViewMatrix() const { return mInverseViewMatrix; }

    void setProjectionMatrix(const mat4& mat) { mProjectionMatrix = mat;  mFOV = mNearPlane = mFarPlane  = -1; }

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

    void setProjectionAsPerspective();

    void setProjectionAsPerspective(Real fov, Real near, Real far);

    void setProjectionAsFrustum(Real left, Real right, Real bottom, Real top, Real near, Real far);

    void setProjectionAsOrtho(Real offset=-0.5f);

    void setProjectionAsOrtho2D(Real offset=-0.5f);

    void setViewMatrixAsLookAt( const vec3& eye, const vec3& center, const vec3& up);

    void getViewMatrixAsLookAt( vec3& eye, vec3& look, 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 mInverseViewMatrix;
    mat4 mProjectionMatrix;
    ref<Viewport> mViewport;
    Frustum mFrustum;
    ref<Transform> mFollowTransform;
    Real mFOV;
    Real mNearPlane;
    Real mFarPlane;
  };
}

#endif