gzCamera.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzCamera.h
// Module       : 
// Description  : Class definition of the gzCamera class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden   
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  990101  Created file    
//
//******************************************************************************
#ifndef __GZ_CAMERA_H__
#define __GZ_CAMERA_H__

#include "gzObject.h"
#include "gzScene.h"
#include "gzMutex.h"

class gzCamera : public gzObject , public gzNameInterface ,public gzMutex
{
public:


    GZ_GRAPH_EXPORT gzCamera( const gzString &name=GZ_EMPTY_STRING);
    
    GZ_GRAPH_EXPORT virtual ~gzCamera(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ------------------- default positioning ------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setHPR( gzReal heading , gzReal pitch , gzReal roll );

    GZ_GRAPH_EXPORT gzVoid  setHPR( const gzVec3 &hpr );
    

    GZ_GRAPH_EXPORT gzVoid  getHPR( gzReal &heading , gzReal &pitch , gzReal &roll );
    GZ_GRAPH_EXPORT gzVec3  getHPR();


    GZ_GRAPH_EXPORT gzVoid  setPosition( gzReal x , gzReal y , gzReal z );
    

    GZ_GRAPH_EXPORT gzVoid  lookAt( gzReal x , gzReal y , gzReal z , gzReal roll=0 , const gzVec3 &up=gzVec3(0,1,0));


    GZ_GRAPH_EXPORT gzVoid  setPosition( const gzVec3 &position );
    

    GZ_GRAPH_EXPORT gzVoid  lookAt( const gzVec3 &position , gzReal roll=0 , const gzVec3 &up=gzVec3(0,1,0));

    GZ_GRAPH_EXPORT gzVoid  useRoiPosition(gzBool on);

    // ------------------- distance and scene viewbox management ------------------

    GZ_GRAPH_EXPORT gzVoid  setNearClipPlane( gzReal distance );


    GZ_GRAPH_EXPORT gzVoid  setFarClipPlane( gzReal distance );

    GZ_GRAPH_EXPORT gzVoid  flipVerticalView(gzBool on);
    GZ_GRAPH_EXPORT gzVoid  flipHorizontalView(gzBool on);


    GZ_GRAPH_EXPORT gzVoid  setScene( gzScene *scene );
    
    GZ_GRAPH_EXPORT gzScene *getScene() { return m_scene.get(); }

    GZ_GRAPH_EXPORT gzVec3  getPosition() { return m_eye; }

    GZ_GRAPH_EXPORT gzVec3  getDirection();
    GZ_GRAPH_EXPORT gzVec3  getNormal();

    // ------------------- pure transform control ---------------------------------

    GZ_GRAPH_EXPORT gzVoid  setTransform( const gzMatrix4 &transform);

    GZ_GRAPH_EXPORT const gzMatrix4 &getTransform() const;


    GZ_GRAPH_EXPORT virtual gzMatrix4 getProjectionTransform() const =0;

    // ------------------- utility methods used by external renderers -----------------

    GZ_GRAPH_EXPORT virtual gzVoid render(gzContext *context , gzULong size_x , gzULong size_y, gzULong screen_width);

    GZ_GRAPH_EXPORT virtual gzBool isVisible( gzContext *context , gzNode *node  )=0;


    GZ_GRAPH_EXPORT virtual gzBool isBeyondFarPlane( gzContext *context , gzNode *node  )=0;

protected:
    
    GZ_GRAPH_EXPORT gzVoid  calculateTransform();

    gzReal  m_near_clip_distance;
    gzReal  m_far_clip_distance;

    gzVec3  m_eye;

    gzReal  m_eye_heading;
    gzReal  m_eye_pitch;
    gzReal  m_eye_roll;

    gzMatrix4               m_cameraMatrix;

    gzMatrix4               m_invCameraMatrix;

    gzRefPointer<gzScene>   m_scene;

    gzBool  m_useRoiPosition:1;
    gzBool  m_flipHorizontal:1;
    gzBool  m_flipVertical:1;
    

};

class gzPerspCamera : public gzCamera
{
public:


    GZ_GRAPH_EXPORT gzPerspCamera(const gzString &name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzPerspCamera(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    GZ_GRAPH_EXPORT virtual gzVoid render(gzContext *context , gzULong size_x , gzULong size_y, gzULong screen_width);


    GZ_GRAPH_EXPORT gzVoid setVerticalFOV( gzReal fov );    

    GZ_GRAPH_EXPORT gzVoid setHorizontalFOV( gzReal fov );

    GZ_GRAPH_EXPORT gzReal getVerticalFOV();    
    GZ_GRAPH_EXPORT gzReal getHorizontalFOV();

    GZ_GRAPH_EXPORT gzVoid setWidth( gzReal width );
    GZ_GRAPH_EXPORT gzVoid setHeight( gzReal height );


    GZ_GRAPH_EXPORT virtual gzBool isVisible( gzContext *context , gzNode *node );


    GZ_GRAPH_EXPORT virtual gzBool isBeyondFarPlane( gzContext *context , gzNode *node  );


    GZ_GRAPH_EXPORT gzVoid  useInfiniteFarPlane(gzBool on);


    GZ_GRAPH_EXPORT virtual gzMatrix4 getProjectionTransform() const;

protected:
    
    gzReal      m_width;
    gzReal      m_height;

    gzReal      m_vertical_FOV;
    gzReal      m_horizontal_FOV;

    gzReal      m_widthFactor;
    gzReal      m_heightFactor;

    gzBool      m_useInfiniteFarPlane;
};

class gzOrthoCamera : public gzCamera
{
public:


    GZ_GRAPH_EXPORT gzOrthoCamera(const gzString &name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzOrthoCamera(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    GZ_GRAPH_EXPORT virtual gzVoid render(gzContext *context , gzULong size_x , gzULong size_y, gzULong screen_width);


    GZ_GRAPH_EXPORT virtual gzBool isVisible( gzContext *context , gzNode *node );


    GZ_GRAPH_EXPORT virtual gzBool isBeyondFarPlane( gzContext *context , gzNode *node  );

    GZ_GRAPH_EXPORT gzVoid setWidth( gzReal width );    
    GZ_GRAPH_EXPORT gzVoid setHeight( gzReal height );

    GZ_GRAPH_EXPORT gzVoid setMagnification( gzReal mag );


    GZ_GRAPH_EXPORT virtual gzMatrix4 getProjectionTransform() const;

protected:

    gzReal  m_width;
    gzReal  m_height;

    gzReal m_mag;

};

// ---------------- gzGenericCamera ------------------

class gzGenericCamera : public gzCamera
{
public:


    GZ_GRAPH_EXPORT gzGenericCamera(const gzString &name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzGenericCamera(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    GZ_GRAPH_EXPORT virtual gzVoid render(gzContext *context , gzULong size_x , gzULong size_y, gzULong screen_width);

    GZ_GRAPH_EXPORT virtual gzBool isVisible( gzContext *context , gzNode *node );


    GZ_GRAPH_EXPORT virtual gzBool isBeyondFarPlane( gzContext *context , gzNode *node  );

    GZ_GRAPH_EXPORT gzVoid setProjectionTransform( const gzMatrix4 &projMat );


    GZ_GRAPH_EXPORT virtual gzMatrix4 getProjectionTransform() const;

protected:

    gzMatrix4   m_projectionMatrix;
};

// ---------------- gzStereoCamera ------------------

class gzStereoCamera : public gzCamera
{
public:


    GZ_GRAPH_EXPORT gzStereoCamera(const gzString &name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzStereoCamera(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    GZ_GRAPH_EXPORT virtual gzVoid render(gzContext *context , gzULong size_x , gzULong size_y, gzULong screen_width);

    GZ_GRAPH_EXPORT virtual gzBool isVisible( gzContext *context , gzNode *node );


    GZ_GRAPH_EXPORT virtual gzBool isBeyondFarPlane( gzContext *context , gzNode *node  );

    // ---------- Stereo specific methods -------------------------------

    GZ_GRAPH_EXPORT gzCamera *getLeftEyeCamera();
    GZ_GRAPH_EXPORT gzCamera *getRightEyeCamera();

    GZ_GRAPH_EXPORT gzVoid  setLeftEyeCamera(gzCamera *camera);
    GZ_GRAPH_EXPORT gzVoid  setRightEyeCamera(gzCamera *camera);


    GZ_GRAPH_EXPORT gzVoid  setCamera(gzCamera *camera);

    GZ_GRAPH_EXPORT gzVoid  setEyeDistance(gzReal dist);
    GZ_GRAPH_EXPORT gzVoid  setFocusDistance(gzReal dist);


    GZ_GRAPH_EXPORT virtual gzMatrix4 getProjectionTransform() const;

protected:

    gzRefPointer<gzCamera>      m_leftEyeCamera;
    gzRefPointer<gzCamera>      m_rightEyeCamera;

    gzReal                      m_eyeDistance;
    gzReal                      m_focusDistance;

private:

    gzCamera    *m_currentRenderCamera;
};

// ---------------- gzMultiLayerCamera ------------------

class gzMultiLayerInfo
{
public:

    gzMultiLayerInfo(): size(GZ_FLOAT_ONE,GZ_FLOAT_ONE),
                        offset(GZ_FLOAT_ZERO,GZ_FLOAT_ZERO),
                        clearStencil(TRUE),
                        clearDepth(TRUE),
                        clearColor(FALSE){}

    gzFloatXY               size;
    gzFloatXY               offset;
    gzBool                  clearStencil;
    gzBool                  clearDepth;
    gzBool                  clearColor;

    gzRefPointer<gzCamera>  camera;
};

class gzMultiLayerCamera : public gzCamera
{
public:

    GZ_GRAPH_EXPORT gzMultiLayerCamera(const gzString &name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzMultiLayerCamera(){};

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    GZ_GRAPH_EXPORT virtual gzVoid render(gzContext *context , gzULong size_x , gzULong size_y, gzULong screen_width);

    GZ_GRAPH_EXPORT virtual gzBool isVisible( gzContext *context , gzNode *node );

    GZ_GRAPH_EXPORT virtual gzBool isBeyondFarPlane( gzContext *context , gzNode *node  );

    GZ_GRAPH_EXPORT virtual gzMatrix4 getProjectionTransform() const;

    // ---------- gzMultiLayerCamera specific methods -------------------------------

    GZ_GRAPH_EXPORT gzVoid      setLayerCamera(gzULong layer,gzCamera *camera);
    GZ_GRAPH_EXPORT gzCamera*   getLayerCamera(gzULong layer);

    GZ_GRAPH_EXPORT gzVoid      setLayerViewportOffset(gzULong layer,gzFloat x , gzFloat y);

    GZ_GRAPH_EXPORT gzVoid      setLayerViewportScale(gzULong layer,gzFloat sx , gzFloat sy);

    GZ_GRAPH_EXPORT gzVoid      clearLayerDepthBuffer(gzULong layer,gzBool on);
    GZ_GRAPH_EXPORT gzVoid      clearLayerStencilBuffer(gzULong layer,gzBool on);
    GZ_GRAPH_EXPORT gzVoid      clearLayerColorBuffer(gzULong layer,gzBool on);

protected:

    gzDynamicArray<gzMultiLayerInfo>        m_layerInfo;

private:

    gzCamera    *m_currentRenderCamera;
};

#endif

---