vrj::SurfaceViewport Class Reference

Defines a display surface an associated projections. More...

#include <vrj/Display/SurfaceViewport.h>

Inheritance diagram for vrj::SurfaceViewport:

[legend]Collaboration diagram for vrj::SurfaceViewport:

[legend]List of all members.

Public Member Functions
	SurfaceViewport ()
virtual	~SurfaceViewport ()
virtual bool	config (jccl::ConfigElementPtr element)
	Takes a display element and configures the viewport based on it.
virtual void	updateProjections (const float positionScale)
	Updates the projection data for this viewport.
void	getCorners (gmtl::Point3f &ll, gmtl::Point3f &lr, gmtl::Point3f &ur, gmtl::Point3f &ul)
virtual std::ostream &	outStream (std::ostream &out, const unsigned int indentLevel=0)
Protected Attributes
The corners in 3Space (for config)
gmtl::Point3f	mLLCorner
gmtl::Point3f	mLRCorner
gmtl::Point3f	mURCorner
gmtl::Point3f	mULCorner
Tracked surface info
Deal with tracked surfaces (HMD, movable walls, desks, etc).
bool	mTracked
	Is this surface tracked?
std::string	mTrackerProxyName
	If tracked, what is the name of the tracker.

---

Detailed Description

Defines a display surface an associated projections.

Definition at line 54 of file SurfaceViewport.h.

---

Constructor & Destructor Documentation

vrj::SurfaceViewport::SurfaceViewport

(

)

[inline]

Definition at line 57 of file SurfaceViewport.h.

      : Viewport()
      , mTracked(false)
   {;}

vrj::SurfaceViewport::~SurfaceViewport

(

)

[virtual]

Definition at line 57 of file SurfaceViewport.cpp.

References vrj::Viewport::mLeftProj, and vrj::Viewport::mRightProj.

{
   if ( NULL != mLeftProj )
   {
      delete mLeftProj;
      mLeftProj = NULL;
   }

   if ( NULL != mRightProj )
   {
      delete mRightProj;
      mRightProj = NULL;
   }
}

---

Member Function Documentation

bool vrj::SurfaceViewport::config

(

jccl::ConfigElementPtr

element

)

[virtual]

Takes a display element and configures the viewport based on it.

Precondition:

element is a valid configuration element.

Postcondition:

display is configured. If there is an error is the specified config, we output error and "fix" the error.

Note:

All derived display classes MUST call this function after doing local configuration.

Reimplemented from vrj::Viewport.

Definition at line 72 of file SurfaceViewport.cpp.

References vrj::Projection::config(), vrj::Viewport::config(), vrj::Projection::LEFT, vrj::Viewport::mLeftProj, mLLCorner, mLRCorner, vrj::Viewport::mRightProj, mTracked, mTrackerProxyName, vrj::Viewport::mType, mULCorner, mURCorner, vrj::Projection::RIGHT, vrj::Projection::setEye(), vrj::Projection::setViewport(), vrj::Viewport::SURFACE, vrj::SurfaceProjection::validateCorners(), vrjDBG_DISP_MGR(), and vrj::InvalidSurfaceException::what().

Referenced by vrj::Display::configViewports().

{
   vprASSERT(element.get() != NULL);
   vprASSERT(element->getID() == "surface_viewport");

   // Call base class config
   if ( ! Viewport::config(element) )
   {
      return false;
   }

   bool result(true);

   mType = SURFACE;

   // Read in the corners
   mLLCorner.set(element->getProperty<float>("lower_left_corner", 0),
                 element->getProperty<float>("lower_left_corner", 1),
                 element->getProperty<float>("lower_left_corner", 2));
   mLRCorner.set(element->getProperty<float>("lower_right_corner", 0),
                 element->getProperty<float>("lower_right_corner", 1),
                 element->getProperty<float>("lower_right_corner", 2));
   mURCorner.set(element->getProperty<float>("upper_right_corner", 0),
                 element->getProperty<float>("upper_right_corner", 1),
                 element->getProperty<float>("upper_right_corner", 2));
   mULCorner.set(element->getProperty<float>("upper_left_corner", 0),
                 element->getProperty<float>("upper_left_corner", 1),
                 element->getProperty<float>("upper_left_corner", 2));

   // Calculate the rotation and the pts
//   calculateSurfaceRotation();
//   calculateCornersInBaseFrame();

   // Get info about being tracked
   mTracked = element->getProperty<bool>("tracked");
   if(mTracked)
   {
      mTrackerProxyName = element->getProperty<std::string>("tracker_proxy");
   }

   if ( NULL != mLeftProj )
   {
      delete mLeftProj;
   }

   if ( NULL != mRightProj )
   {
      delete mRightProj;
   }

   // Create Projection objects
   // NOTE: The -'s are because we are measuring distance to
   //  the left(bottom) which is opposite the normal axis direction
   //vjMatrix rot_inv;
   //rot_inv.invert(mSurfaceRotation);
   SurfaceProjection* left_proj(NULL);
   SurfaceProjection* right_proj(NULL);

   if(!mTracked)
   {
      left_proj = new SurfaceProjection(mLLCorner, mLRCorner, mURCorner,
                                        mULCorner);
      right_proj = new SurfaceProjection(mLLCorner, mLRCorner, mURCorner,
                                         mULCorner);
   }
   else
   {
      left_proj = new TrackedSurfaceProjection(mLLCorner, mLRCorner,
                                               mURCorner, mULCorner,
                                               mTrackerProxyName);
      right_proj = new TrackedSurfaceProjection(mLLCorner, mLRCorner,
                                                mURCorner, mULCorner,
                                                mTrackerProxyName);
   }

   try
   {
      left_proj->validateCorners();
      right_proj->validateCorners();

      // NOTE: Even if the corner validation above failed, we still proceed with
      // setting up mLeftProj and mRightProj. This is because other code is not
      // written to handle the case of a viewport having no projections. This
      // could definitely be improved.
      mLeftProj  = left_proj;
      mRightProj = right_proj;

      // Configure the projections
      mLeftProj->config(element);
      mLeftProj->setEye(Projection::LEFT);
      mLeftProj->setViewport(this);

      mRightProj->config(element);
      mRightProj->setEye(Projection::RIGHT);
      mRightProj->setViewport(this);
   }
   catch (InvalidSurfaceException& ex)
   {
      vprDEBUG(vrjDBG_DISP_MGR, vprDBG_CRITICAL_LVL)
         << clrOutBOLD(clrRED, "ERROR")
         << ": The surface defined by the viewport named\n" << vprDEBUG_FLUSH;
      vprDEBUG_NEXT(vrjDBG_DISP_MGR, vprDBG_CRITICAL_LVL)
         << "       '" << element->getName() << "' is invalid!\n"
         << vprDEBUG_FLUSH;
      vprDEBUG_NEXT(vrjDBG_DISP_MGR, vprDBG_CRITICAL_LVL)
         << ex.what() << std::endl << vprDEBUG_FLUSH;

      delete left_proj;
      delete right_proj;

      result = false;
   }

   return result;
}

void vrj::SurfaceViewport::updateProjections

(

const float

positionScale

)

[virtual]

Updates the projection data for this viewport.

This uses the data from the head position for this viewport.

Parameters:

positionScale

Scale value for converting from Juggler units (meters) to the display units

Implements vrj::Viewport.

Definition at line 188 of file SurfaceViewport.cpp.

References vrj::Projection::calcViewMatrix(), vrj::User::getHeadPosProxy(), vrj::User::getInterocularDistance(), vrj::Viewport::mLeftProj, vrj::Viewport::mRightProj, and vrj::Viewport::mUser.

{
   gmtl::Matrix44f left_eye_pos, right_eye_pos;     // NOTE: Eye coord system is -z forward, x-right, y-up

   // -- Calculate Eye Positions -- //
   gmtl::Matrix44f cur_head_pos = mUser->getHeadPosProxy()->getData(positionScale);
   /*
   Coord  head_coord(cur_head_pos);       // Create a user readable version

   vprDEBUG(vprDBG_ALL, vprDBG_HVERB_LVL)
      << "vjDisplay::updateProjections: Getting head position" << std::endl
      << vprDEBUG_FLUSH;
   vprDEBUG(vprDBG_ALL, vprDBG_HVERB_LVL) << "\tHeadPos:" << head_coord.pos << "\tHeadOr:"
                        << head_coord.orient << std::endl << vprDEBUG_FLUSH;
                        */

   // Compute location of left and right eyes
   //float interocularDist = 2.75f/12.0f;
   float interocular_dist = mUser->getInterocularDistance();
   interocular_dist *= positionScale;              // Scale eye separation
   float eye_offset = interocular_dist/2.0f;      // Distance to move eye

   left_eye_pos = cur_head_pos * gmtl::makeTrans<gmtl::Matrix44f>(gmtl::Vec3f( -eye_offset, 0, 0));
   right_eye_pos = cur_head_pos * gmtl::makeTrans<gmtl::Matrix44f>(gmtl::Vec3f(eye_offset, 0, 0));

   mLeftProj->calcViewMatrix(left_eye_pos, positionScale);
   mRightProj->calcViewMatrix(right_eye_pos, positionScale);
}

void vrj::SurfaceViewport::getCorners	(	gmtl::Point3f &	ll,
		gmtl::Point3f &	lr,
		gmtl::Point3f &	ur,
		gmtl::Point3f &	ul
	)			[inline]

Definition at line 80 of file SurfaceViewport.h.

References mLLCorner, mLRCorner, mULCorner, and mURCorner.

   {
      ll = mLLCorner; lr = mLRCorner; ur = mURCorner; ul = mULCorner;
   }

std::ostream & vrj::SurfaceViewport::outStream	(	std::ostream &	out,
		const unsigned int	indentLevel = 0
	)			[virtual]

Reimplemented from vrj::Viewport.

Definition at line 217 of file SurfaceViewport.cpp.

References vrj::Viewport::LEFT_EYE, vrj::Viewport::mLeftProj, vrj::Viewport::mRightProj, vrj::Viewport::mView, vrj::Projection::outStream(), vrj::Viewport::outStream(), vrj::Viewport::RIGHT_EYE, and vrj::Viewport::STEREO.

{
   Viewport::outStream(out, indentLevel);
   out << std::endl;

   const std::string indent_text(indentLevel, ' ');

   /*
   out << "LL: " << mLLCorner << ", LR: " << mLRCorner
       << ", UR: " << mURCorner << ", UL:" << mULCorner << std::endl;
   out << "surfRot: \n" << mSurfaceRotation << std::endl;
   */
   if ( mView == vrj::Viewport::LEFT_EYE || mView == vrj::Viewport::STEREO )
   {
      out << indent_text << "Left projection:\n";
      mLeftProj->outStream(out, indentLevel + 2);
      out << std::endl;
   }
   if ( mView == vrj::Viewport::RIGHT_EYE || mView == vrj::Viewport::STEREO )
   {
      out << indent_text << "Right projection:\n";
      mRightProj->outStream(out, indentLevel + 2);
      out << std::endl;
   }

   return out;
}

---

Member Data Documentation

gmtl::Point3f vrj::SurfaceViewport::mLLCorner [protected]

Definition at line 92 of file SurfaceViewport.h.

Referenced by config(), and getCorners().

gmtl::Point3f vrj::SurfaceViewport::mLRCorner [protected]

Definition at line 93 of file SurfaceViewport.h.

Referenced by config(), and getCorners().

gmtl::Point3f vrj::SurfaceViewport::mURCorner [protected]

Definition at line 94 of file SurfaceViewport.h.

Referenced by config(), and getCorners().

gmtl::Point3f vrj::SurfaceViewport::mULCorner [protected]

Definition at line 95 of file SurfaceViewport.h.

Referenced by config(), and getCorners().

bool vrj::SurfaceViewport::mTracked [protected]

Is this surface tracked?

Definition at line 103 of file SurfaceViewport.h.

Referenced by config().

std::string vrj::SurfaceViewport::mTrackerProxyName [protected]

If tracked, what is the name of the tracker.

Definition at line 104 of file SurfaceViewport.h.

Referenced by config().

---

The documentation for this class was generated from the following files:

• SurfaceViewport.h
• SurfaceViewport.cpp

---