vrj::GlPipe Class Reference

Handles the rendering on multiple GLWindows in a single process. More...

#include <vrj/Draw/OGL/GlPipe.h>

Collaboration diagram for vrj::GlPipe:

[legend]List of all members.

Public Member Functions
	GlPipe (size_t num, GlDrawManager *glMgr, vpr::Mutex *drawMgrWinLock)
	Constructor.
	~GlPipe ()
int	start ()
	Starts the pipe running.
void	controlLoop (void *nullParam)
	The main loop routine.
void	stop ()
	Stops the pipe.
void	triggerRender ()
	Triggers rendering of the pipe to start.
void	completeRender ()
	Blocks until rendering of the windows is completed.
void	triggerSwap ()
	Triggers swapping of all pipe's windows.
void	completeSwap ()
	Blocks until swapping of the windows is completed.
void	addWindow (GlWindow *win)
	Adds a GLWindow to the window list.
void	removeWindow (GlWindow *win)
	Removes a GLWindow from the window list.
int	hasWindows ()
	Returns true if pipe has any windows.
const std::vector< GlWindow * > &	getOpenWindows ()
	Return a list of open windows.

---

Detailed Description

Handles the rendering on multiple GLWindows in a single process.

This class can be used to group glWindows to render efficiently on one pipe (SGI terminology).

Date:

1-12-98

Definition at line 57 of file GlPipe.h.

---

Constructor & Destructor Documentation

vrj::GlPipe::GlPipe	(	size_t	num,
		GlDrawManager *	glMgr,
		vpr::Mutex *	drawMgrWinLock
	)			[inline]

Constructor.

Parameters:

	num	The ID number of the pipe.
	glMgr	The OpenGL Draw Manager instance associated with this pipe.
	drawMgrWinLock	Cross-pipe lock associated with the OpenGL Draw Manager to prevent windows from opening simultaneously on different pipes.

Note:

All contained windows SHOULD have the same pipe number.

Definition at line 72 of file GlPipe.h.

      : mControlFunctor(NULL)
      , mActiveThread(NULL)
      , mPipeNum(num)
      , mControlExit(0)
      , mGlDrawManager(glMgr)
      , mDrawMgrWinLock(drawMgrWinLock)
      , mRenderTriggerSema(0)
      , mRenderCompleteSema(0)
      , mSwapTriggerSema(0)
      , mSwapCompleteSema(0)
   {
      mThreadRunning = false;
   }

vrj::GlPipe::~GlPipe

(

)

Definition at line 58 of file GlPipe.cpp.

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

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

---

Member Function Documentation

int vrj::GlPipe::start

(

)

Starts the pipe running.

Precondition:

The pipe should not have a thread of control yet.

Postcondition:

The pipe has it's own thread of control and is ready to operate The Thread of control is running controlLoop.

Note:

The pipe does NOT have to have any windows in order to run that way we can add windows to pipes at run-time.

Definition at line 77 of file GlPipe.cpp.

References controlLoop(), and vrjDBG_DRAW_MGR().

Referenced by vrj::GlDrawManager::addDisplay().

{
    vprASSERT(mThreadRunning == false);        // We should not be running yet

    // Create a new thread to call the control loop
    mControlFunctor =
      new vpr::ThreadMemberFunctor<GlPipe>(this, &GlPipe::controlLoop, NULL);

    mActiveThread = new vpr::Thread(mControlFunctor);

    vprDEBUG(vrjDBG_DRAW_MGR, vprDBG_CONFIG_LVL)
       << "[vrj::GlPipe::start()] Started control loop. " << mActiveThread
       << std::endl << vprDEBUG_FLUSH;
    return 1;        // XXX: Is this always true?
}

void vrj::GlPipe::controlLoop

(

void *

nullParam

)

The main loop routine.

-Checks for new windows
-renders all windows when triggered

Definition at line 174 of file GlPipe.cpp.

References vrj::GlDrawManager::getApp(), and vrj::GlApp::pipePreDraw().

Referenced by start().

{
   boost::ignore_unused_variable_warning(nullParam);
   mThreadRunning = true;     // We are running so set flag
   // Loop until flag set
   while (!mControlExit)
   {
      // --- handle EVENTS for the windows --- //
      // XXX: This may have to be here because of need to get open window event (Win32)
      // otherwise I would like to move it to being after the swap to get better performance
      {
         for (unsigned int winId=0;winId<mOpenWins.size();winId++)
         {
            mOpenWins[winId]->checkEvents();
         }
      }

      // --- RENDER the windows ---- //
      {
         mRenderTriggerSema.acquire();

         GlApp* the_app = mGlDrawManager->getApp();

         // --- pipe PRE-draw function ---- //
         the_app->pipePreDraw();      // Can't get a context since I may not be guaranteed a window

         // Render the windows
         for (unsigned int winId = 0 ; winId < mOpenWins.size() ; winId++)
         {
            renderWindow(mOpenWins[winId]);
         }
         mRenderCompleteSema.release();
      }

      // ----- SWAP the windows ------ //
      {
         mSwapTriggerSema.acquire();

         // Swap all the windows
         for (unsigned int winId = 0 ; winId < mOpenWins.size() ; winId++)
         {
            swapWindowBuffers(mOpenWins[winId]);
         }

         mSwapCompleteSema.release();
      }
      checkForWindowsToClose();  // Checks for closing windows
      checkForNewWindows();      // Checks for new windows to open
   }

   mThreadRunning = false;     // We are not running
}

void vrj::GlPipe::stop

(

)

Stops the pipe.

Postcondition:

Flag is set to tell pipe to stop rendering.

Definition at line 227 of file GlPipe.cpp.

References getOpenWindows(), removeWindow(), triggerRender(), and triggerSwap().

{
   // Close all open windows/contexts.
   std::vector<GlWindow*> windows = getOpenWindows();
   for ( std::vector<GlWindow*>::iterator itr = windows.begin();
         itr != windows.end();
         ++itr )
   {
      removeWindow(*itr);
   }

   mControlExit = 1;     // Set the control loop exit flag
   
   // We don't actually need to call completeRender() or completeSwap()
   // since we don't care about when they complete. We only care about
   // joining the thread
   triggerRender();
   //completeRender();
   triggerSwap();
   //completeSwap();

   mActiveThread->join();
}

void vrj::GlPipe::triggerRender

(

)

Triggers rendering of the pipe to start.

Precondition:

The pipe must have a thread of control.

Postcondition:

The pipe has be told to start rendering.

Definition at line 97 of file GlPipe.cpp.

References vrjDBG_DRAW_MGR().

Referenced by stop().

{
   //vprASSERT(mThreadRunning == true);      // We must be running
   while (!mThreadRunning)
   {
      vprDEBUG(vrjDBG_DRAW_MGR,vprDBG_HVERB_LVL) << "Waiting in for thread to start triggerRender.\n" << vprDEBUG_FLUSH;
      vpr::Thread::yield();
   }

   mRenderTriggerSema.release();
}

void vrj::GlPipe::completeRender

(

)

Blocks until rendering of the windows is completed.

Precondition:

The pipe must have a thread of control.

Postcondition:

The pipe has completed its rendering.

Definition at line 113 of file GlPipe.cpp.

{
   vprASSERT(mThreadRunning == true);      // We must be running

   mRenderCompleteSema.acquire();
}

void vrj::GlPipe::triggerSwap

(

)

Triggers swapping of all pipe's windows.

Precondition:

The pipe must have a thread of control.

Postcondition:

The pipe has be told to swap.

Definition at line 121 of file GlPipe.cpp.

Referenced by stop().

{
   vprASSERT(mThreadRunning == true);
   mSwapTriggerSema.release();
}

void vrj::GlPipe::completeSwap

(

)

Blocks until swapping of the windows is completed.

Precondition:

The pipe must have a thread of control.

Postcondition:

The pipe has completed its rendering.

Definition at line 128 of file GlPipe.cpp.

{
   vprASSERT(mThreadRunning == true);
   mSwapCompleteSema.acquire();
}

void vrj::GlPipe::addWindow

(

GlWindow *

win

)

Adds a GLWindow to the window list.

Control loop must now open the window on the next frame.

Definition at line 139 of file GlPipe.cpp.

References vrjDBG_DRAW_MGR().

Referenced by vrj::GlDrawManager::addDisplay().

{
   vpr::Guard<vpr::Mutex> guardNew(mNewWinLock);       // Protect the data
   vprDEBUG(vrjDBG_DRAW_MGR, vprDBG_STATE_LVL)
      << "[vrj::GlPipe::addWindow()] Pipe: " << mPipeNum
      << " adding window (to new wins):\n" << win
      << std::endl << vprDEBUG_FLUSH;
   mNewWins.push_back(win);
}

void vrj::GlPipe::removeWindow

(

GlWindow *

win

)

Removes a GLWindow from the window list.

Note:

The window is not actually removed until the next draw trigger.

Definition at line 153 of file GlPipe.cpp.

References vrjDBG_DRAW_MGR().

Referenced by vrj::GlDrawManager::removeDisplay(), and stop().

{
   vpr::Guard<vpr::Mutex> guardClosing(mClosingWinLock);
   vprDEBUG(vrjDBG_DRAW_MGR, vprDBG_STATE_LVL)
      << "[vrj::GlPipe::removeWindow()] Pipe: " << mPipeNum
      << " window added to closingWins.\n" << win
      << std::endl << vprDEBUG_FLUSH;
   mClosingWins.push_back(win);
}

int vrj::GlPipe::hasWindows

(

)

[inline]

Returns true if pipe has any windows.

Definition at line 157 of file GlPipe.h.

   {
      return ( (mNewWins.size() > 0) || (mOpenWins.size() > 0));
   }

const std::vector<GlWindow*>& vrj::GlPipe::getOpenWindows

(

)

[inline]

Return a list of open windows.

Definition at line 163 of file GlPipe.h.

Referenced by stop().

   {
      return mOpenWins;
   }

---

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

• GlPipe.h
• GlPipe.cpp

---