thinlenscamera.h

Go to the documentation of this file.

/*
    toxic - A Global Illumination Renderer
    Copyright (C) 2003-2004 Francois Beaune
    Contact: http://toxicengine.sourceforge.net/

    This file is part of toxic.

    toxic 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.

    toxic 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 toxic; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef TOXIC_RENDERER_THINLENSCAMERA_H
#define TOXIC_RENDERER_THINLENSCAMERA_H

#include "common/math/matrix4.h"
#include "common/math/point2.h"
#include "common/math/point3.h"
#include "common/math/real.h"
#include "common/math/vector3.h"
#include "globals.h"
#include "icamera.h"

namespace toxic {

    class Context;
    class Ray;
    class Scene;

    class ThinLensCamera : public ICamera {
    public:
        //! 'm' is the object space to world space transformation matrix.
        //! 'hfov' is the horizontal field of view, expressed in radians.
        ThinLensCamera(
            const sheep::Matrix4 &m,
            sheep::Real hfov,
            sheep::Real aspect_ratio,
            sheep::Real fstop,
            sheep::Real focal_length,
            sheep::Real focal_distance
        );

        //! This constructor intializes the focal distance with the autofocus
        //! mechanism. Autofocus computes the right focal distance so that the
        //! point of the scene visible through the point 'target' is in focus
        //! plane. 'target' is a point on the film plane, expressed in NDC.
        //! 'm' is the object space to world space transformation matrix.
        //! 'hfov' is the horizontal field of view, expressed in radians.
        ThinLensCamera(
            const sheep::Matrix4 &m,
            sheep::Real hfov,
            sheep::Real aspect_ratio,
            sheep::Real fstop,
            sheep::Real focal_length,
            const sheep::Point2 &af_target
        );

        //! This method must be called only once, after the camera is completely
        //! configured, and before it is used for the first time.
        virtual void Finalize(
            const Context &context,
            const Scene *scene
        );

        //! Returns a ray whose origin is at camera location, and which
        //! is directed toward the point 'p'. 'p' is a point on the film
        //! plane. It is expressed in NDC. The returned ray is expressed
        //! in world space. The direction of the returned ray IS unit-length.
        virtual Ray ComputeRay(
            const Context &context,
            const sheep::Point2 &p
        ) const;

        //! Projects a point in the scene to the image plane.
        virtual sheep::Point2 Project(
            const sheep::Point3 &p
        ) const;

    private:
        sheep::Real m_lens_radius;      //!< Lens radius (computed user defined f-stop number and DOF focal length).
        sheep::Real m_focal_distance;   //!< User defined distance of the focus plane from the lens center.
        bool m_af_enabled;              //!< True if autofocus is enabled, false otherwise.
        sheep::Point2 m_af_target;      //!< Focus point, expressed in NDC.
    };

#include "thinlenscamera.inl"

}

#endif  // !TOXIC_RENDERER_THINLENSCAMERA_H

---