Camera.h

Go to the documentation of this file.

#pragma once
 
#include <tdme/tdme.h>
#include <tdme/engine/fwd-tdme.h>
#include <tdme/engine/subsystems/renderer/fwd-tdme.h>
#include <tdme/engine/Frustum.h>
#include <tdme/math/fwd-tdme.h>
#include <tdme/math/Matrix4x4.h>
#include <tdme/math/Vector3.h>
 
using tdme::engine::subsystems::renderer::Renderer;
using tdme::engine::Frustum;
using tdme::math::Matrix4x4;
using tdme::math::Vector3;
 
/**
 * Camera
 * @author Andreas Drewke
 * @version $Id$
 */
class tdme::engine::Camera final
{
public:
    enum FrustumMode { FRUSTUMMODE_PERSPECTIVE, FRUSTUMMODE_ORTHOGRAPHIC };
    enum CameraMode { CAMERAMODE_LOOKAT, CAMERAMODE_NONE };
 
private:
    STATIC_DLL_IMPEXT static Vector3 defaultUp;
    Renderer* renderer { nullptr };
    int32_t width;
    int32_t height;
    float fovX;
    float zNear;
    float zFar;
    CameraMode cameraMode;
    FrustumMode frustumMode;
    float orthographicFrustumScale;
    Vector3 lookFrom;
    Vector3 lookAt;
    Vector3 upVector;
    Vector3 forwardVector;
    Vector3 sideVector;
    Matrix4x4 projectionMatrix;
    Matrix4x4 modelViewMatrix;
    Matrix4x4 mvpMatrix;
    Matrix4x4 mvpInvertedMatrix;
    Frustum* frustum { nullptr };
 
public:
    /**
     * Public constructor
     * @param renderer renderer
     */
    Camera(Renderer* renderer);
 
    /**
     * Destructor
     */
    ~Camera();
 
    /**
     * @return width
     */
    inline int getWidth() {
        return width;
    }
 
    /**
     * @return height
     */
    inline int getHeight() {
        return height;
    }
 
    /**
     * @return camera mode
     */
    inline CameraMode getCameraMode() const {
        return cameraMode;
    }
 
    /**
     * Set camera mode
     * @param camera mode
     */
    inline void setCameraMode(CameraMode cameraMode) {
        this->cameraMode = cameraMode;
    }
 
    /**
     * @return frustum mode
     */
    inline FrustumMode getFrustumMode() const {
        return frustumMode;
    }
 
    /**
     * Set frustum mode
     * @param frustum mode
     */
    inline void setFrustumMode(FrustumMode frustumMode) {
        this->frustumMode = frustumMode;
    }
 
    /**
     * @return orthographic frustum scale
     */
    inline float getOrthographicFrustumScale() const {
        return orthographicFrustumScale;
    }
 
    /**
     * Set orthographic frustum scale
     * @param orthographicFrustumScale orthographic frustum scale
     */
    inline void setOrthographicFrustumScale(float orthographicFrustumScale) {
        this->orthographicFrustumScale = orthographicFrustumScale;
    }
 
    /**
     * @return field of view X
     */
    inline float getFovX() const {
        return fovX;
    }
 
    /**
     * Set field of view X
     * @param fovX field of view X
     */
    inline void setFovX(float fovX) {
        this->fovX = fovX;
    }
 
    /**
     * @return float
     */
    inline float getZNear() const {
        return zNear;
    }
 
    /**
     * Set z near
     * @param zNear zNear
     */
    inline void setZNear(float zNear) {
        this->zNear = zNear;
    }
 
    /**
     * @return float
     */
    inline float getZFar() const {
        return zFar;
    }
 
    /**
     * Set z far
     * @param zFar zFar
     */
    inline void setZFar(float zFar) {
        this->zFar = zFar;
    }
 
    /**
     * @return up vector
     */
    inline const Vector3& getUpVector() const {
        return upVector;
    }
 
    /**
     * Set up vector
     * @param upVector up vector
     */
    inline void setUpVector(const Vector3& upVector) {
        this->upVector = upVector;
    }
 
    /**
     * @return forward vector
     */
    inline const Vector3& getForwardVector() const {
        return forwardVector;
    }
 
    /**
     * Set forward vector
     * @param forwardVector forward vector
     */
    inline void setForwardVector(const Vector3& forwardVector) {
        this->forwardVector = forwardVector;
    }
 
    /**
     * @return side vector
     */
    inline const Vector3& getSideVector() const {
        return sideVector;
    }
 
    /**
     * Set side vector
     * @param sideVector side vector
     */
    inline void setSideVector(const Vector3& sideVector) {
        this->sideVector = sideVector;
    }
 
    /**
     * @return look from vector
     */
    inline const Vector3& getLookFrom() const {
        return lookFrom;
    }
 
    /**
     * Set look from
     * @param lookFrom look from
     */
    inline void setLookFrom(const Vector3& lookFrom) {
        this->lookFrom = lookFrom;
    }
 
    /**
     * @return look at vector
     */
    inline const Vector3& getLookAt() const {
        return lookAt;
    }
 
    /**
     * Set look at
     * @param lookAt look at
     */
    inline void setLookAt(const Vector3& lookAt) {
        this->lookAt = lookAt;
    }
 
    /**
     * @return model view matrix or camera matrix
     */
    inline const Matrix4x4& getModelViewMatrix() const {
        return modelViewMatrix;
    }
 
    /**
     * @return projection matrix
     */
    inline const Matrix4x4& getProjectionMatrix() const {
        return projectionMatrix;
    }
 
    /**
     * @return model view projection matrix
     */
    inline const Matrix4x4& getModelViewProjectionMatrix() const {
        return mvpMatrix;
    }
 
    /**
     * @return inverted model view porjection matrix
     */
    inline const Matrix4x4& getModelViewProjectionInvertedMatrix() const {
        return mvpInvertedMatrix;
    }
 
    /**
     * @return frustum
     */
    inline Frustum* getFrustum() {
        return frustum;
    }
 
    /**
     * Computes the up vector for given look from and look at vectors
     * @param lookFrom look from
     * @param lookAt look at
     * @return up vector
     */
    static Vector3 computeUpVector(const Vector3& lookFrom, const Vector3& lookAt);
 
    /**
     * Sets up camera while resizing the view port
     * @param contextIdx context index
     * @param width width
     * @param height height
     */
    void update(int contextIdx, int32_t width, int32_t height);
 
private:
 
    /**
     * Computes the projection matrix
     * @return projection matrix
     */
    Matrix4x4& computeProjectionMatrix();
 
    /**
     * Computes projection matrix for given look from, look at and up vector
     * @return model view matrix
     */
    Matrix4x4& computeModelViewMatrix();
 
};