---

Viewport.h

Go to the documentation of this file.

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2003 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: Viewport.h,v $
 * Date modified: $Date: 2003/07/10 23:59:14 $
 * Version:       $Revision: 1.31 $
 * -----------------------------------------------------------------
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VRJ_VIEWPORT_H_
#define _VRJ_VIEWPORT_H_

#include <vrj/vrjConfig.h>

#include <string>
#include <gmtl/Vec.h>
#include <jccl/Config/ConfigElementPtr.h>

namespace vrj
{

class Display;
class Projection;
class User;

class VJ_CLASS_API Viewport
{
public:
   Viewport()
      : mUser(NULL), mDisplay(NULL),
        mLeftProj(NULL), mRightProj(NULL)
   {
      mXorigin = mYorigin = mXsize = mYsize = -1.0f;
      mType = Viewport::UNDEFINED;
      mActive = false;
   }

   Viewport(const Viewport& v)
      : mName(v.mName), mUser(v.mUser), mType(v.mType), mView(v.mView),
        mActive(v.mActive), mDisplay(v.mDisplay),
        mViewportElement(v.mViewportElement), mXorigin(v.mXorigin),
        mYorigin(v.mYorigin), mXsize(v.mXsize), mYsize(v.mYsize),
        mLeftProj(v.mLeftProj), mRightProj(v.mRightProj)
   {
   }

   virtual ~Viewport()
   {;}

   enum Type
   {
      UNDEFINED,  
      SURFACE,    
      SIM         
   };

   enum View
   {
      NONE=0,       
      LEFT_EYE=1,   
      RIGHT_EYE=2,  
      STEREO=3      
   };

public:
   virtual void config(jccl::ConfigElementPtr element);

   virtual void updateProjections(const float positionScale) = 0;

public:
   Viewport::Type getType()
   { return mType;}

   bool isSimulator()
   { return (mType == SIM); }

   bool isSurface()
   { return (mType == SURFACE); }

   bool isActive()
   { return mActive; }

   void setName(const std::string& name)
   {
      mName = name;
   }

   const std::string& getName()
   {
      return mName;
   }

   bool inStereo()
   { return (mView == STEREO); }

   // Which view are we supposed to render
   Viewport::View getView()
   { return mView; }

   void setOriginAndSize(float xo, float yo, float xs, float ys)
   { mXorigin = xo; mYorigin = yo; mXsize = xs; mYsize = ys;}
   void getOriginAndSize(float& xo, float& yo, float& xs, float& ys)
   {
      xo = mXorigin; yo = mYorigin; xs = mXsize; ys = mYsize;
   }

   jccl::ConfigElementPtr getConfigElement()
   {
      return mViewportElement;
   }

   User*  getUser()
   { return mUser;}

   void setDisplay(Display* disp)
   { mDisplay = disp; }
   Display* getDisplay()
   { return mDisplay; }

   Projection* getLeftProj()
   { return mLeftProj; }

   Projection* getRightProj()
   { return mRightProj; }


   virtual std::ostream& outStream(std::ostream& out,
                                   const unsigned int indentLevel = 0);
   friend VJ_API(std::ostream&) operator<<(std::ostream& out, Viewport& viewport);

protected:
   std::string       mName;               
   User*             mUser;               
   Viewport::Type    mType;               
   Viewport::View    mView;               
   bool              mActive;             
   Display*          mDisplay;            
   jccl::ConfigElementPtr mViewportElement; 
   float          mXorigin, mYorigin, mXsize, mYsize;

   Projection*   mLeftProj;      
   Projection*   mRightProj;     

};

}

#endif

---