3DCamera.h

Go to the documentation of this file.

//! @file 3DCamera.h
//! @brief C3DCamera class for handling camera object
//////////////////////////////////////////////////////////////////////
 
#if !defined(AFX_3DCAMERA_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_)
#define AFX_3DCAMERA_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_
 
#ifdef _MSC_VER
#pragma once
#endif // _MSC_VER
 
#include "3DBaseObject.h"
#include "3DObject.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
//! @enum OBJECT_KINDOF
//! @brief Camera CustomData internal attributes
//////////////////////////////////////////////////////////////////////
typedef enum Camera3DID XEnumType(unsigned int)
{
    C3DCAMERA_PROJECTION = MAKE_CUSTOM_ID('c', 'a', 'p', 'j'),      //!< int
    C3DCAMERA_TARGET = MAKE_CUSTOM_ID('c', 'a', 't', 'g'),          //!< longuint 
    C3DCAMERA_FOV = MAKE_CUSTOM_ID('c', 'a', 'f', 'o'),         //!< double (angle in radian for perspective, distance for orthographic)
    C3DCAMERA_ASPECT_RATIO = MAKE_CUSTOM_ID('c', 'a', 'a', 'r'),    //!< double
    C3DCAMERA_ZOOM = MAKE_CUSTOM_ID('c', 'a', 'z', 'm'),            //!< double
    C3DCAMERA_NEAR_CLIP = MAKE_CUSTOM_ID('c', 'a', 'n', 'c'),       //!< double: distance in cm
    C3DCAMERA_FAR_CLIP = MAKE_CUSTOM_ID('c', 'a', 'f', 'c'),        //!< double
    C3DCAMERA_FOCUS_DISTANCE = MAKE_CUSTOM_ID('c', 'a', 'f', 'd'),  //!< double
    C3DCAMERA_APERTURE = MAKE_CUSTOM_ID('c', 'a', 'a', 'p'),        //!< double (f/<ap>)
} Camera3DID;
 
// defaults
#define C3DCAMERA_DEFAULT_PROJECTION (CAMERA_PROJECTION_PERSPECTIVE)
 
#define C3DCAMERA_DEFAULT_FOV (DEG2RAD(45.f))
#define C3DCAMERA_DEFAULT_ASPECT_RATIO (1.f)
#define C3DCAMERA_DEFAULT_ZOOM (1.f)
 
#define C3DCAMERA_DEFAULT_NEAR_CLIP (-1.0f)
#define C3DCAMERA_DEFAULT_FAR_CLIP (-1.0f)
 
#define C3DCAMERA_DEFAULT_FOCUS_DISTANCE (0.f)
#define C3DCAMERA_DEFAULT_APERTURE (8.f)
 
// Enums
typedef enum _CAMERA_PROJECTION_TYPE XEnumType(unsigned int)
{
    CAMERA_PROJECTION_PERSPECTIVE = 0,
    CAMERA_PROJECTION_ORTHOGRAPHIC,
 
    CAMERA_NB_PROJECTION_TYPES,     //Keep it last
} C3DCAMERA_PROJECTION_TYPE;
 
//! @class C3DCamera
//! @brief C3DCamera handles camera object.
//! @details GetFinalObject returns a camera model in order to display the camera itself.
//! Camera node contains the transformation matrix of the camera, that can be use to display this object.\n
//! Camera node matrix is the invert of the LookAt matrix (which can be used to position the scene in the front of camera).
class DLL_3DFUNCTION C3DCamera : public C3DBaseObject 
{
    DECLARE_SERIAL_XOBJECT(C3DCamera);
 
public:
    C3DCamera(OBJECT_KINDOF kindOf = OBJECT_CAMERA);
    virtual ~C3DCamera();
 
    static bool LookAt(C4x4Matrix& matrix, const C3DPoint& eye, const C3DPoint& target, const C3DVector& up); //!< Compute the lookAt matrix from the given vector. Equivalent to glLookAt. Invert this matrix if you intend to use it as the node matrix
    static bool PositionMatrix(C4x4Matrix& matrix, const C3DPoint& eye, const C3DPoint& target, const C3DVector& up); //!< Camera node position (invert of LookAt)
 
    // Getters & setters
    C3DCAMERA_PROJECTION_TYPE GetProjection() const;
    void SetProjection(C3DCAMERA_PROJECTION_TYPE v);
 
    SceneNodeID GetTarget() const;
    void SetTarget(SceneNodeID v);
    bool HasTarget() const;
 
    double GetVFov() const;
    void SetVFov(double radianAngle);
    double GetAspectRatio() const;
    void SetAspectRatio(double v);
    
    double GetNearClip() const;
    void SetNearClip(double v);
    double GetFarClip() const;
    void SetFarClip(double v);
    void SetNearFarClip(double vn, double vf);
 
    double GetFocusDistance() const;
    void SetFocusDistance(double v);
    double GetAperture() const;
    void SetAperture(double v);
 
    // Ortho methods
    double GetVOrthoZoom() const;
    void SetVOrthoZoom(double v);
 
    bool IsDefined(unsigned int param) const;
 
    virtual void SetScene(C3DScene *scene); //!< Attach scene and update guid for camera and its displayable
    virtual bool IsFinalObject() const { return false; }
    virtual C3DBaseObject *GetFinalObject(bool detach = false, bool computeIfNeeded = true)
    {
        if(!displayable && computeIfNeeded)
            GenerateDisplayable();
 
        return displayable;
    }
 
    virtual unsigned int GetChecksum(unsigned int checksumFlags = CHECKSUM_ALL) const; //!< Return a value that is a simple way to check if the geometry changed between two call to the method
 
private:
    C3DObject* displayable;
    void GenerateDisplayable();
 
};
 
END_MOOTOOLS_NAMESPACE
 
#endif // !defined(AFX_3DCAMERA_H__5C85DAE7_BE95_4F8B_B661_B0CF9BE55255__INCLUDED_)