Camera.h

Go to the documentation of this file.

/* This file is part of the Zenipex Library (zenilib).
 * Copyright (C) 2011 Mitchell Keith Bloch (bazald).
 *
 * zenilib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * zenilib 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with zenilib.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ZENI_CAMERA_H
#define ZENI_CAMERA_H

#include <Zeni/Collision.h>
#include <Zeni/Coordinate.h>
#include <Zeni/Vector3f.h>
#include <Zeni/Matrix4f.h>
#include <Zeni/Quaternion.h>

#include <Zeni/Define.h>

namespace Zeni {

  class ZENI_DLL Camera {
  public:
    Camera(const Point3f &position = ZENI_DEFAULT_CAMERA_POSITION,
           const Quaternion &orientation = ZENI_DEFAULT_CAMERA_ORIENTATION,
           const float &near_clip = ZENI_DEFAULT_CAMERA_NEAR_CLIP,
           const float &far_clip = ZENI_DEFAULT_CAMERA_FAR_CLIP,
           const float &fov_rad_ = ZENI_DEFAULT_CAMERA_FOV,
           const float &tunnel_vision_factor = ZENI_DEFAULT_CAMERA_TUNNEL_VISION);

    // Accessors
    inline Vector3f get_forward() const; 
    inline Vector3f get_up() const; 
    inline Vector3f get_left() const; 
    inline float get_fov_deg() const; 
    inline float get_tunnel_vision_factor() const; 

    // Modifiers
    inline void set_fov_deg(const float &degrees); 

    // Convenience Functions

    inline Point3f get_tunneled_position() const; 
    inline float get_tunneled_near_clip() const; 
    inline float get_tunneled_far_clip() const; 
    inline float get_tunneled_fov_deg() const; 
    inline float get_tunneled_fov_rad() const; 
    inline Matrix4f get_view_matrix() const; 
    inline Matrix4f get_projection_matrix(const std::pair<Point2i, Point2i> &viewport) const; 

    void adjust_yaw(const float &theta); 
    void adjust_pitch(const float &phi); 
    void adjust_roll(const float &rho);  

    void move_forward_xy(const float &distance); 
    void move_left_xy(const float &distance); 
    void turn_left_xy(const float &theta); 

    void look_at(const Point3f &world_coord, const Vector3f &horizon_plane_normal = ZENI_DEFAULT_UP_VECTOR); 
    void look_at(const Point3f &world_coord, const Collision::Plane &horizon_plane); 

    Point3f position;
    Quaternion orientation; // relative to forward(1.0f, 0.0f, 0.0f), up(0.0f, 0.0f, 1.0f)

    float near_clip; // should never be less than 1.0f, and higher values will be better still
    float far_clip; // should always be higher than near_clip
    float fov_rad; // should be in range (0.0f, pi)

    float tunnel_vision_factor; // 1.0f is default, higher values will decrease the field-of-view, while keeping the near clip view the same
  };

}

#include <Zeni/Undefine.h>

#endif