D:/CHAI3D/build-2-0-0/2.0.0/win32/src/scenegraph/CCamera.h

Go to the documentation of this file.

//===========================================================================
/*
    This file is part of the CHAI 3D visualization and haptics libraries.
    Copyright (C) 2003-2009 by CHAI 3D. All rights reserved.

    This library is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License("GPL") version 2
    as published by the Free Software Foundation.

    For using the CHAI 3D libraries with software that can not be combined
    with the GNU GPL, and for taking advantage of the additional benefits
    of our support services, please contact CHAI 3D about acquiring a
    Professional Edition License.

    \author    <http://www.chai3d.org>
    \author    Francois Conti
    \author    Dan Morris
    \version   2.0.0 $Rev: 251 $
*/
//===========================================================================

//---------------------------------------------------------------------------
#ifndef CCameraH
#define CCameraH
//---------------------------------------------------------------------------
#include "scenegraph/CGenericObject.h"
#include "math/CMaths.h"
#include "files/CImageLoader.h"
//---------------------------------------------------------------------------
class cWorld;
//---------------------------------------------------------------------------

const int CHAI_MONO             =  0;

const int CHAI_STEREO_LEFT      = -1;

const int CHAI_STEREO_RIGHT     =  1;

const int CHAI_STEREO_DEFAULT   =  -1000;

#define CHAI_MAX_CLIP_PLANES 6

//---------------------------------------------------------------------------

//===========================================================================
//===========================================================================

//===========================================================================
//===========================================================================
struct cClippingPlane
{
    //-----------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //-----------------------------------------------------------------------

    cClippingPlane()
    {
        enabled = -1;
        peqn[0] = peqn[1] = peqn[2] = peqn[3] = 0.0f;
    }


    //-----------------------------------------------------------------------
    // MEMBERS:
        //-----------------------------------------------------------------------

    int enabled;

    double peqn[4];
};


//===========================================================================
//===========================================================================
class cCamera : public cGenericObject
{
  friend class cWorld;

  public:
    
    //-----------------------------------------------------------------------
    // CONSTRUCTOR & DESTRUCTOR:
    //-----------------------------------------------------------------------

    cCamera(cWorld* iParent);

    virtual ~cCamera() {};


        //-----------------------------------------------------------------------
    // METHODS - MOUSE SELECTION:
        //-----------------------------------------------------------------------

    cWorld* getParentWorld() { return (m_parentWorld); }

    virtual bool select(const int a_windowPosX, const int a_windowPosY,
                        const int a_windowWidth, const int a_windowHeight,
                        cCollisionRecorder& a_collisionRecorder,
                                                cCollisionSettings& a_collisionSettings);


        //-----------------------------------------------------------------------
    // METHODS - POSITION & ORIENTATION:
        //-----------------------------------------------------------------------

    virtual bool set(const cVector3d& a_localPosition,
                                         const cVector3d& a_localLookAt,
                                         const cVector3d& a_localUp);

    cVector3d getLookVector()  const { return m_localRot.getCol0(); }

    cVector3d getUpVector()    const { return m_localRot.getCol2(); }

    cVector3d getRightVector() const { return m_localRot.getCol1(); }

    double m_projectionMatrix[16];


        //-----------------------------------------------------------------------
    // METHODS - CLIPPING PLANES:
        //-----------------------------------------------------------------------

    void setClippingPlanes(const double a_distanceNear, const double a_distanceFar);

    double getNearClippingPlane() { return (m_distanceNear); }

    double getFarClippingPlane() { return (m_distanceFar); }

    void adjustClippingPlanes();

    void enableClipPlane(const unsigned int& index, const int& enable, const double* peqn=0);


        //-----------------------------------------------------------------------
    // METHODS - FIELD OF VIEW & OPTICS: 
        //-----------------------------------------------------------------------

    void setFieldViewAngle(double a_fieldViewAngle);

    double getFieldViewAngle() { return (m_fieldViewAngle); }

    int setStereoFocalLength(double a_stereoFocalLength);

    double getStereoFocalLength() { return (m_stereoFocalLength); }

    int setStereoEyeSeparation(double a_stereoEyeSeparation);

    double getStereoEyeSeparation() { return (m_stereoEyeSeparation); }


        //-----------------------------------------------------------------------
    // METHODS - RENDERING AND IMAGING:
        //-----------------------------------------------------------------------

    virtual void renderView(const int a_windowWidth, const int a_windowHeight, const int a_imageIndex = CHAI_MONO);

    void copyImageData(cImageLoader* a_image);

    virtual void enableMultipassTransparency(bool enable);

    virtual void onDisplayReset(const bool a_affectChildren = true);


        //-----------------------------------------------------------------------
    // MEMBERS - FRONT AND BACK PLANES:
        //-----------------------------------------------------------------------

        /*
                These are special 'children' of the camera that are rendered independently of
                all other objects, intended to contain 2d objects only.  The 'back' scene is
                rendered before the 3d objects; the 'front' scene is rendered after the
                3d object.  These are made public variables to allow convenient access to
                the scenegraph management functions.

                These objects are rendered through an orthographic projection matrix, so the
                positive z axis faces the camera.  Depth is currently not used.  Lighting
                is disabled during rendering.
    */

        cGenericObject m_front_2Dscene;

    cGenericObject m_back_2Dscene;


  protected:

        //-----------------------------------------------------------------------
    // MEMBERS:
        //-----------------------------------------------------------------------

    cWorld *m_parentWorld;

    double m_distanceNear;

    double m_distanceFar;

    cClippingPlane m_clipPlanes[CHAI_MAX_CLIP_PLANES];

    double m_fieldViewAngle;

    // Stereo Parameters:

    double m_stereoFocalLength;

    double m_stereoEyeSeparation;

    bool m_useMultipassTransparency;

    void render2dSceneGraph(cGenericObject* a_graph, int a_width, int a_height);

    bool m_performingDisplayReset;

    unsigned int m_lastDisplayWidth;

    unsigned int m_lastDisplayHeight;
};

//---------------------------------------------------------------------------
#endif
//---------------------------------------------------------------------------

---

CHAI3D 2.0.0 documentation
Please address any questions to support@chai3d.org
(C) 2003-2009 - CHAI 3D
All Rights Reserved.