GLCamera.h

Go to the documentation of this file.

/*

License

Menge
Copyright © and trademark ™ 2012-14 University of North Carolina at Chapel Hill. 
All rights reserved.

Permission to use, copy, modify, and distribute this software and its documentation 
for educational, research, and non-profit purposes, without fee, and without a 
written agreement is hereby granted, provided that the above copyright notice, 
this paragraph, and the following four paragraphs appear in all copies.

This software program and documentation are copyrighted by the University of North 
Carolina at Chapel Hill. The software program and documentation are supplied "as is," 
without any accompanying services from the University of North Carolina at Chapel 
Hill or the authors. The University of North Carolina at Chapel Hill and the 
authors do not warrant that the operation of the program will be uninterrupted 
or error-free. The end-user understands that the program was developed for research 
purposes and is advised not to rely exclusively on the program for any reason.

IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS 
BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL 
DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS 
DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE 
AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY 
DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY 
OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND 
THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS 
TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu

*/

#ifndef __GLCAMERA_H__
#define __GLCAMERA_H__

#include "CoreConfig.h"
#include "graphCommon.h"

namespace Menge {

    namespace SceneGraph {

        class MENGE_API GLCamera {
        public:
            enum CamEnum { ORTHO,
                PERSP };
            
            GLCamera();
            
            GLCamera( const Vector3 & p);
            
            GLCamera( const Vector3 & p, const Vector3 & t);

            GLCamera( const Vector3 & p, const Vector3 & t, const Vector3 & u);

            void setOrtho( float scaleFactor=1.f );

            void setPersp();

            void setActive();

            Vector3 getPosition() const { return _position; }

            void setPosition( const Vector3 & p );

            void setPosition( float x, float y, float z );

            Vector3 getTarget() const { return _target; }
            
            void setTarget( const Vector3 & p );
            
            void setTarget( float x, float y, float z );
            
            Vector3 getUp() const { return _up; }
            
            void setUp( const Vector3 & u );
            
            void setUp( float x, float y, float z );

            inline void setFOV( float fov ) { _fov = fov; }

            inline float getFOV() const { return _fov; }

            inline void setFarPlane( float fp ) { _farPlane = fp; }

            inline float getFarPlane() const { return _farPlane; }

            inline void setNearPlane( float np ) { _nearPlane = np; }
            
            inline float getNearPlane() const { return _nearPlane; }

            float getOrthoScaleFactor() const;

            void setViewport( int w, int h, int left=0, int bottom=0 );
            

            void setProjMat( int w, int h ) const ;

            void setSelectMat( int * selectPoint ) const ;

            void setGLView() const;

            void viewXAxis( bool downPositive=true );
            
            void viewYAxis( bool downPositive=true );
            
            void viewZAxis( bool downPositive=true );

            void pan( float angle );

            void tilt( float angle );

            void truck( float amount );

            void crane( float amount );

            void dolly ( float amount );

            void dollyPlane( float amount );

            void zoom( float amount );

            void orbitVerticalAxis( float angle );

            void orbitHorizontalAxis( float angle );

            
            float targetDistance() const;

            Vector3 targetDir() const;

            Vector3 getActualUpDir() const;

            Vector3 getRightDir() const;

            void outputState() const;

        private:

            CamEnum _type;

            Vector3 _position;

            Vector3 _target;

            Vector3 _up;

            float _farPlane;

            float _nearPlane;

            float _fov;

            mutable unsigned int _viewWidth;
            
            mutable unsigned int _viewHeight;

            mutable bool _dirtyProj;

            float _orthoHWidth;

            void _setProjMat() const;
        };

    }   // namespace SceneGraph
}   // namespace Menge

#endif