YiCameraController.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_CAMERA_CONTROLLER_H_
#define _YI_CAMERA_CONTROLLER_H_

class CYIAbstractCameraSceneNode;
class CYISceneNode;

#include <glm/gtc/epsilon.hpp>
#include <glm/vec3.hpp>

#include "framework/YiPredef.h"

/*
    This camera control class is meant as a temporary and experimental way to animate the camera within You.i Engine. It is not a complete solution and should not be how camera animation is handled moving forward. This is meant to allow basic camera animation until the camera is fully integrated into the scene tree.
*/

class CYICameraController
{
public:
    CYICameraController();
    ~CYICameraController();

    enum CAMERA_CENTER_RULES {
        CENTER_VERTICAL,    
        CENTER_HORIZONTAL,  
        CENTER              
    };

    void SetDynamicCamera(CYIAbstractCameraSceneNode *pCamera);

    const CYIAbstractCameraSceneNode *GetDynamicCamera() const;

    void CenterCameraOn(CYISceneNode *pTarget, CAMERA_CENTER_RULES eCenterRule, const glm::vec3 &staticOffset = glm::vec3());

    void AnimateCenterCameraOn(CYISceneNode *pTarget, CAMERA_CENTER_RULES eCenterRule, float fVelocity, const glm::vec3 &staticOffset = glm::vec3());

    void AnimateScrollBy(const glm::vec3 &offset);

    void ScrollBy(const glm::vec3 &offset);

    bool Update();

    void ReleaseDynamicCamera();

    void SetDynamicCameraRange(float fMaximumRange);

    float GetDynamicCameraRange();

private:
    struct CameraViewProperties {
        glm::vec3 position;
        glm::vec3 target;
        glm::vec3 up;

        bool operator==(const CameraViewProperties &other)
        {
            return (glm::all(glm::epsilonEqual(position, other.position, glm::epsilon<glm::vec3::value_type>())) &&
                    glm::all(glm::epsilonEqual(target,   other.target,   glm::epsilon<glm::vec3::value_type>())) &&
                    glm::all(glm::epsilonEqual(up,       other.up,       glm::epsilon<glm::vec3::value_type>())));
        }
    };

    enum CAMERA_TARGET_FLAGS {
        MAINTAIN_DISTANCE_X = 1,  
        MAINTAIN_DISTANCE_Y = 2,  
        MAINTAIN_DISTANCE_Z = 4   
    };

    CYIAbstractCameraSceneNode *m_pDynamicCamera;     
    CameraViewProperties m_StaticCameraProperties;    
    CameraViewProperties m_DynamicCameraDestination;  
    float m_fDynamicCameraVelocity; 
    float m_fDynamicCameraRange; 
    CameraViewProperties m_DynamicCameraTarget;       
    void RestoreDynamicCamera();

    CameraViewProperties DefineCameraForTarget(CYISceneNode *pNode, uint32_t eTargetMask);
};

#endif // _YI_CAMERA_CONTROLLER_H_