StereoHelper.h

Go to the documentation of this file.

/*

Copyright (c) 2017, Dr Franck P. Vidal (franck.p.vidal@fpvidal.net),
http://www.fpvidal.net/
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

3. Neither the name of the Bangor University nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/


#ifndef __StereoHelper_h
#define __StereoHelper_h


//******************************************************************************
//  Include
//******************************************************************************
#ifndef GVXR_CONFIG_H
#include "gVirtualXRay/gVirtualXRayConfig.h"
#endif

#ifndef GVXR_MATRIX4X4_H
#include "gVirtualXRay/Matrix4x4.h"
#endif

#ifndef GVXR_TYPES_H
#include "gVirtualXRay/Types.h"
#endif


//******************************************************************************
//  namespace
//******************************************************************************
namespace gVirtualXRay {


//==============================================================================
//==============================================================================
class StereoHelper
//------------------------------------------------------------------------------
{
//******************************************************************************
public:
    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    typedef enum EyeTypeTag
    {
        LEFT_EYE  = 0, //< Left eye (stereo vision)
        RIGHT_EYE = 1, //< Right eye (stereo vision)
        MONO      = 2  //< Monovision
    } EyeType;


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    StereoHelper();
    

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

    //--------------------------------------------------------------------------
    void setIntraocularDistance(double aDistance);


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

    //--------------------------------------------------------------------------
    double getIntraocularDistance() const;


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

    //--------------------------------------------------------------------------
    void setScreenAspectRatio(double aRatio);


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

    //--------------------------------------------------------------------------
    void setFieldOfViewY(double aFOVY);


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

    //--------------------------------------------------------------------------
    double getFieldOfViewY() const;


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

    //--------------------------------------------------------------------------
    void setNear(double aPlane);


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

    //--------------------------------------------------------------------------
    double getNear() const;


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

    //--------------------------------------------------------------------------
    void setFar(double aPlane);


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

    //--------------------------------------------------------------------------
    double getFar() const;


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

    //--------------------------------------------------------------------------
    void setScreenProjectionPlane(double aPlane);


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

    //--------------------------------------------------------------------------
    const MATRIX4& getLeftEyeProjectionMatrix();


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

    //--------------------------------------------------------------------------
    const MATRIX4& getRightEyeProjectionMatrix();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void swapEye();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    bool enable();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    void disable();


    //--------------------------------------------------------------------------
    //--------------------------------------------------------------------------
    bool isActive() const;


//******************************************************************************
protected:
    void update();


    double m_intraocular_distance;


    MATRIX4 m_left_eye_projection_matrix;


    MATRIX4 m_right_eye_projection_matrix;


    double m_left_eye_frustum[4];


    double m_right_eye_frustum[4];


    double m_near;


    double m_far;


    double m_fovy;


    double m_screen_aspect_ratio;


    double m_screen_projection_plane;


    bool m_matrices_are_up_to_date;


    EyeType m_current_eye;


    bool m_stereo_currently_in_use;
};


} // namespace gVirtualXRay


//******************************************************************************
#include "StereoHelper.inl"


#endif // __StereoHelper_h