vrj::OsgApp Class Reference

Encapsulates an Open Scene Graph (OSG) application. More...

#include <vrj/Draw/OSG/OsgApp.h>

Inheritance diagram for vrj::OsgApp:

[legend]Collaboration diagram for vrj::OsgApp:

[legend]List of all members.

Public Member Functions
	OsgApp (Kernel *kern=NULL)
virtual	~OsgApp ()
virtual void	initScene ()=0
	Initializes the scene.
virtual osg::Group *	getScene ()=0
	Gets the root of the scene to render.
virtual void	configSceneView (osgUtil::SceneView *newSceneViewer)
	Configures newly created scene viewers.
virtual void	latePreFrame ()
	Function called after preFrame() and application-specific data synchronization (in a cluster configuration) but before the start of a new frame.
virtual void	draw ()
	Function to set up and render the scene using OSG.
virtual void	init ()
	Application initialization function.
void	contextInit ()
	Function that is called immediately after a new context is created.
virtual void	contextClose ()
	Function that is called immediately before a context is closed.
virtual void	contextPreDraw ()
	Function that is called upon entry into the context before rendering.
virtual void	bufferPreDraw ()
	Function that is called once for each frame buffer of an OpenGL context.
virtual void	pipePreDraw ()
	Function that is called at the beginning of the drawing of each pipe.
Protected Member Functions
void	update ()
	Performs the update stage on the scene graph.
Protected Attributes
vrj::GlContextData< osg::ref_ptr< osgUtil::SceneView > >	sceneViewer

---

Detailed Description

Encapsulates an Open Scene Graph (OSG) application.

This defines the base class from which OSG-based application classes should be derived. It makes use of the OpenGL Draw Manager.

Note:

This class makes use of gadget::PositionInterface internally and requires that a proxy or proxy alias named "VJHead" is defined in the VR Juggler configuration.

See also:

vrj::GlApp

Definition at line 68 of file OsgApp.h.

---

Constructor & Destructor Documentation

vrj::OsgApp::OsgApp

(

Kernel *

kern = NULL

)

[inline]

Definition at line 71 of file OsgApp.h.

      : GlApp(kern)
      , mFrameNumber(0)
   {
      ;
   }

virtual vrj::OsgApp::~OsgApp

(

)

[inline, virtual]

Definition at line 78 of file OsgApp.h.

   {
      ;
   }

---

Member Function Documentation

virtual void vrj::OsgApp::initScene

(

)

[pure virtual]

Initializes the scene.

Called by init() to initialize the scene.

Referenced by init().

virtual osg::Group* vrj::OsgApp::getScene

(

)

[pure virtual]

Gets the root of the scene to render.

Called each frame to get the current scene to render.

Referenced by draw(), and update().

virtual void vrj::OsgApp::configSceneView

(

osgUtil::SceneView *

newSceneViewer

)

[inline, virtual]

Configures newly created scene viewers.

This is called immediately after a new scene viewer is created for a context. This is the place to configure application background colors and other viewer-specific information.

Postcondition:

newSceneViewer is initialized.

Definition at line 103 of file OsgApp.h.

Referenced by contextInit().

   {
      newSceneViewer->setDefaults();
      newSceneViewer->init();
      newSceneViewer->setClearColor(osg::Vec4(0.0f, 0.0f, 0.0f, 0.0f));

      // Needed for stereo to work.
      newSceneViewer->setDrawBufferValue(GL_NONE);
   }

virtual void vrj::OsgApp::latePreFrame

(

)

[inline, virtual]

Function called after preFrame() and application-specific data synchronization (in a cluster configuration) but before the start of a new frame.

If this method is overridden, it must be called as the last thing done by the overriding version. This calls update(), which is used to update this application object's scene graph.

Note:

Subclasses overriding this method must call this method implementation as the last step.

Since:

2.0.2

Reimplemented from vrj::App.

Definition at line 127 of file OsgApp.h.

References update().

   {
      update();
   }

void vrj::OsgApp::draw

(

)

[inline, virtual]

Function to set up and render the scene using OSG.

Override this method with great care. All the logic to handle multi-pipe rendering and other VR Juggler features happens here.

Precondition:

OpenGL state has correct transformation and buffer selected.

Postcondition:

The current scene has been drawn.

< The openGL manager that we are rendering for.

Implements vrj::GlApp.

Definition at line 333 of file OsgApp.h.

References vrj::GlDrawManager::currentUserData(), vrj::GlApp::getDrawManager(), vrj::Projection::getFrustum(), vrj::GlUserData::getGlWindow(), vrj::Viewport::getOriginAndSize(), vrj::GlWindow::getOriginSize(), vrj::GlUserData::getProjection(), getScene(), vrj::Projection::getViewMatrix(), vrj::GlUserData::getViewport(), vrj::Frustum::VJ_BOTTOM, vrj::Frustum::VJ_FAR, vrj::Frustum::VJ_LEFT, vrj::Frustum::VJ_NEAR, vrj::Frustum::VJ_RIGHT, and vrj::Frustum::VJ_TOP.

{
   glClear(GL_DEPTH_BUFFER_BIT);

   // Users have reported problems with OpenGL reporting stack underflow
   // problems when the texture attribute bit is pushed here, so we push all
   // attributes *except* GL_TEXTURE_BIT.
   glPushAttrib(GL_ALL_ATTRIB_BITS & ~GL_TEXTURE_BIT);
   glPushAttrib(GL_TRANSFORM_BIT);
   glPushAttrib(GL_VIEWPORT_BIT);

   glMatrixMode(GL_MODELVIEW);
   glPushMatrix();

   glMatrixMode(GL_PROJECTION);
   glPushMatrix();

   glMatrixMode(GL_TEXTURE);
   glPushMatrix();


   osg::ref_ptr<osgUtil::SceneView> sv;
   sv = (*sceneViewer);    // Get context specific scene viewer
   vprASSERT(sv.get() != NULL);

   // Set the timing information in the scene view.
   sv->setFrameStamp(mFrameStamp.get());

   GlDrawManager*    gl_manager;    
   gl_manager = GlDrawManager::instance();

   // Set the up the viewport (since OSG clears it out)
   float vp_ox, vp_oy, vp_sx, vp_sy;   // The float vrj sizes of the view ports
   int w_ox, w_oy, w_width, w_height;  // Origin and size of the window
   gl_manager->currentUserData()->getViewport()->getOriginAndSize(vp_ox, vp_oy, vp_sx, vp_sy);
   gl_manager->currentUserData()->getGlWindow()->getOriginSize(w_ox, w_oy, w_width, w_height);

   // compute unsigned versions of the viewport info (for passing to glViewport)
   unsigned ll_x = unsigned(vp_ox*float(w_width));
   unsigned ll_y = unsigned(vp_oy*float(w_height));
   unsigned x_size = unsigned(vp_sx*float(w_width));
   unsigned y_size = unsigned(vp_sy*float(w_height));

   // Add the tree to the scene viewer and set properties
   sv->setSceneData(getScene());
   //sv->setCalcNearFar(false);
   sv->setComputeNearFarMode(osgUtil::CullVisitor::DO_NOT_COMPUTE_NEAR_FAR);
   sv->setViewport(ll_x, ll_y, x_size, y_size);

   //Get the view matrix and the frustrum form the draw manager
   GlDrawManager* drawMan = dynamic_cast<GlDrawManager*>(this->getDrawManager());
   vprASSERT(drawMan != NULL);
   GlUserData* userData = drawMan->currentUserData();

   //Get the frustrum
   Projection* project = userData->getProjection();
   Frustum frustum = project->getFrustum();
   sv->setProjectionMatrixAsFrustum(frustum[Frustum::VJ_LEFT],
                                    frustum[Frustum::VJ_RIGHT],
                                    frustum[Frustum::VJ_BOTTOM],
                                    frustum[Frustum::VJ_TOP],
                                    frustum[Frustum::VJ_NEAR],
                                    frustum[Frustum::VJ_FAR]);

   // Copy the view matrix
   sv->setViewMatrix(osg::Matrix(project->getViewMatrix().mData));

   //Draw the scene
   // NOTE: It is not safe to call osgUtil::SceneView::update() here; it
   // should only be called by a single thread. The equivalent of calling
   // osgUtil::SceneView::update() is in vrj::OsgApp::update().
   sv->cull();
   sv->draw();

   glMatrixMode(GL_TEXTURE);
   glPopMatrix();

   glMatrixMode(GL_PROJECTION);
   glPopMatrix();

   glMatrixMode(GL_MODELVIEW);
   glPopMatrix();

   glPopAttrib();
   glPopAttrib();
   glPopAttrib();
}

virtual void vrj::OsgApp::init

(

)

[inline, virtual]

Application initialization function.

Execute any initialization needed before the graphics API is started. If this method is overridden, it must be called by the overriding version. This calls initScene(), which is used to set up this application object's scene graph.

Note:

Derived classes MUST call base class version of this method.

Reimplemented from vrj::App.

Definition at line 151 of file OsgApp.h.

References vrj::App::init(), and initScene().

   {
      mUpdateVisitor = new osgUtil::UpdateVisitor();
      mFrameStamp    = new osg::FrameStamp();
      mUpdateVisitor->setFrameStamp(mFrameStamp.get());

      GlApp::init();

      mHead.init("VJHead");

      //Create the scene
      this->initScene();
   }

void vrj::OsgApp::contextInit

(

)

[inline, virtual]

Function that is called immediately after a new context is created.

Use this function to create context-specific data structures such as display lists and texture objects that are known to be required when the context is created.

Precondition:

The OpenGL context has been set to the new context.

Postcondition:

The application has completed context-specific initialization.

Reimplemented from vrj::GlApp.

Definition at line 283 of file OsgApp.h.

References configSceneView().

{
   unsigned int unique_context_id = GlDrawManager::instance()->getCurrentContext();

   // --- Create new context specific scene viewer -- //
   osg::ref_ptr<osgUtil::SceneView> new_sv(new osgUtil::SceneView);
   this->configSceneView(new_sv.get());            // Configure the new viewer
   new_sv->getState()->setContextID(unique_context_id);

   // This will eventually be changed to no light and all lighting will be handled
   // by the application.  For the time being it fixes the lighting inconsistanies
   // over multiple screens
   new_sv->setLightingMode(osgUtil::SceneView::SKY_LIGHT);

   (*sceneViewer) = new_sv;

   //Setup OpenGL light
   //This should actualy be done in the simulator code
   GLfloat light0_ambient[] = { 0.1f,  0.1f,  0.1f,  1.0f};
   GLfloat light0_diffuse[] = { 0.8f,  0.8f,  0.8f,  1.0f};
   GLfloat light0_specular[] = { 1.0f,  1.0f,  1.0f,  1.0f};
   GLfloat light0_position[] = {0.0f, 0.75f, 0.75f, 0.0f};

   GLfloat mat_ambient[] = { 0.7f, 0.7f,  0.7f,  1.0f};
   GLfloat mat_diffuse[] = { 1.0f,  0.5f,  0.8f,  1.0f};
   GLfloat mat_specular[] = { 1.0f,  1.0f,  1.0f,  1.0f};
   GLfloat mat_shininess[] = { 50.0f};
   //GLfloat mat_emission[] = { 1.0f,  1.0f,  1.0f,  1.0f};
   GLfloat no_mat[] = { 0.0f,  0.0f,  0.0f,  1.0f};

   glLightfv(GL_LIGHT0, GL_AMBIENT,  light0_ambient);
   glLightfv(GL_LIGHT0, GL_DIFFUSE,  light0_diffuse);
   glLightfv(GL_LIGHT0, GL_SPECULAR,  light0_specular);
   glLightfv(GL_LIGHT0, GL_POSITION,  light0_position);

   glMaterialfv( GL_FRONT, GL_AMBIENT, mat_ambient );
   glMaterialfv( GL_FRONT,  GL_DIFFUSE, mat_diffuse );
   glMaterialfv( GL_FRONT, GL_SPECULAR, mat_specular );
   glMaterialfv( GL_FRONT,  GL_SHININESS, mat_shininess );
   glMaterialfv( GL_FRONT,  GL_EMISSION, no_mat);

   glEnable(GL_DEPTH_TEST);
   glEnable(GL_NORMALIZE);
   glEnable(GL_LIGHTING);
   glEnable(GL_LIGHT0);
   glEnable(GL_COLOR_MATERIAL);
   glShadeModel(GL_SMOOTH);
}

virtual void vrj::OsgApp::contextClose

(

)

[inline, virtual]

Function that is called immediately before a context is closed.

Use the function to clean up any context-specific data structures.

Reimplemented from vrj::GlApp.

Definition at line 180 of file OsgApp.h.

   {
      ;
   }

virtual void vrj::OsgApp::contextPreDraw

(

)

[inline, virtual]

Function that is called upon entry into the context before rendering.

This can be used to allocate context-specific data dynamically.

Precondition:

The OpenGL context has been set to the context for drawing.

Postcondition:

The application object has executed any commands that need to be executed only once per context, per frame.

Note:

This function can be used for things that need to happen every frame but only once per context.

Reimplemented from vrj::GlApp.

Definition at line 196 of file OsgApp.h.

   {
      ;
   }

virtual void vrj::OsgApp::bufferPreDraw

(

)

[inline, virtual]

Function that is called once for each frame buffer of an OpenGL context.

This function is executed after contextInit() (if needed) but before contextPreDraw(). It is called once per frame buffer (see note).

Precondition:

The OpenGL context has been set to the context for drawing.

Postcondition:

The application object has executed any commands that need to be executed once per context, per buffer, per frame.

Note:

This function is designed to be used when some task must be performed only once per frame buffer (i.e., once for the left buffer, once for the right buffer). For example, the OpenGL clear color should be defined and glClear(GL_COLOR_BUFFER_BIT) should be called in this method.

Reimplemented from vrj::GlApp.

Definition at line 216 of file OsgApp.h.

   {
      ;
   }

virtual void vrj::OsgApp::pipePreDraw

(

)

[inline, virtual]

Function that is called at the beginning of the drawing of each pipe.

Precondition:

The library is preparing to render all windows on a given pipe.

Postcondition:

Any pre-pipe user calls have been done.

Note:

Currently the OpenGL context is not set when this function is called. This is a TEST function. USE AT YOUR OWN RISK!!!

Reimplemented from vrj::GlApp.

Definition at line 230 of file OsgApp.h.

   {
      ;
   }

void vrj::OsgApp::update

(

)

[inline, protected]

Performs the update stage on the scene graph.

This function should be called as the last thing that happens in latePreFrame(). If latePreFrame() is not overridden, then this happens automatically. Otherwise be sure to call vrj::OsgApp::latePreFrame() as the last thing in application object's override of latePreFrame().

Precondition:

The library is preparing to switch from the serial preDraw stages to the parallel draw stages.

Postcondition:

The scene graph update stage is complete and it is ready for cull and draw to be called in parallel.

Note:

This function also takes care of time-based features in the scene graph.

Since:

2.0.2

Definition at line 253 of file OsgApp.h.

References getScene().

Referenced by latePreFrame().

   {
      ++mFrameNumber;

      // Update the frame stamp with information from this frame.
      mFrameStamp->setFrameNumber(mFrameNumber);
      mFrameStamp->setReferenceTime(mHead->getTimeStamp().secd());

      // Set up the time and frame number so time-dependent things (animations,
      // particle system) function correctly.
      // XXX: This may not be necessary.
      mUpdateVisitor->setTraversalNumber(mFrameNumber);

      // Update the scene by traversing it with the the update visitor which
      // will call all node update callbacks and animations. This is
      // equivalent to calling osgUtil::SceneView::update() but does not
      // require access to the context-specific osgUtil::SceneView instance.
      getScene()->accept(*mUpdateVisitor);
   }

---

Member Data Documentation

vrj::GlContextData< osg::ref_ptr<osgUtil::SceneView> > vrj::OsgApp::sceneViewer [protected]

Definition at line 273 of file OsgApp.h.

---

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

• OsgApp.h

---