al_Lens.hpp

#ifndef INCLUDE_AL_LENS_HPP
#define INCLUDE_AL_LENS_HPP
 
/*  Allocore --
  Multimedia / virtual environment application class library
 
  Copyright (C) 2009. AlloSphere Research Group, Media Arts & Technology, UCSB.
  Copyright (C) 2012. The Regents of the University of California.
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:
 
    Redistributions of source code must retain the above copyright notice,
    this list of conditions and the following disclaimer.
 
    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.
 
    Neither the name of the University of California 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.
 
 
  File description:
  Optical properties for scene rendering
 
  File author(s):
  Lance Putnam, 2010, putnam.lance@gmail.com
  Graham Wakefield, 2010, grrrwaaa@gmail.com
  Wesley Smith, 2010, wesley.hoke@gmail.com
*/
 
#include "al/math/al_Matrix4.hpp"
#include "al/math/al_Vec.hpp"
#include "al/spatial/al_Pose.hpp"
 
#ifdef AL_WINDOWS
#undef near
#undef far
#endif
 
namespace al {
 
class Lens {
 public:
  Lens(double fovy = 30, double nearClip = 0.1, double farClip = 100,
       double focalLength = 6, double eyeSep = 0.02);
 
  // setters
  Lens& fovy(double v);  
  Lens& fovx(double v,
             double aspect);  
  Lens& near(double v) {
    mNear = v;
    return *this;
  }  
  Lens& far(double v) {
    mFar = v;
    return *this;
  }  
  Lens& focalLength(double v) {
    mFocalLength = v;
    return *this;
  }  
  Lens& eyeSep(double v) {
    mEyeSep = v;
    return *this;
  }  
 
  double fovy() const {
    return mFovy;
  }  
  double near() const { return mNear; }  
  double far() const { return mFar; }    
  double focalLength() const { return mFocalLength; }  
  double eyeSep() const { return mEyeSep; }            
  double eyeSepAuto() const {
    return focalLength() / 30.0;
  }  
 
 
  double heightAtDepth(double depth) const { return depth * mTanFOV; }
 
  double heightAtNear() const { return heightAtDepth(near()); }
 
  static double getFovyForHeight(double height, double depth);
 
 
  static double getFovyForFovX(double fovx, double aspect);
 
 protected:
  double mFovy;         // Lens aperture (degrees)
  double mTanFOV;       // Cached factor for computing frustum dimensions
  double mNear, mFar;   // Cutting plane distances
  double mFocalLength;  // Focal length along vd
  double mEyeSep;       // Eye separation
  //  Vec3d mStereoOffset;    // eye offset vector (right eye; left eye is
  //  inverse), usually (1, 0, 0)
};
 
}  // namespace al
 
#endif