vrj::OpenSGApp Class Reference

Base type for OpenSG application objects. More...

#include <vrj/Draw/OpenSG/OpenSGApp.h>

Inheritance diagram for vrj::OpenSGApp:

[legend]Collaboration diagram for vrj::OpenSGApp:

[legend]List of all members.

Public Member Functions
	OpenSGApp (vrj::Kernel *kern=NULL)
virtual	~OpenSGApp ()
virtual void	initScene ()=0
	Scene initialization function.
virtual OSG::NodePtr	getScene ()=0
	Get the OpenSG Scene root.
virtual void	init ()
	Initializes OpenSG for drawing.
virtual void	apiInit ()
	Initializes OpenSG.
virtual void	exit ()
	Shuts down OpenSG.
virtual void	bufferPreDraw ()
	Called once per frame, per buffer (basically context).
virtual void	contextInit ()
	Called once per context at context creation.
virtual void	contextPreDraw ()
	Function that is called upon entry into the context before rendering.
virtual void	contextPostDraw ()
	Function that is called upon exit of the context after rendering.
virtual void	draw ()
	Function that renders the scene.
Protected Attributes
vrj::GlContextData< context_data >	mContextData
	OpenSG context data.
OSG::UInt32	OSG_MAIN_ASPECT_ID
Classes
struct	context_data

---

Detailed Description

Base type for OpenSG application objects.

Definition at line 64 of file OpenSGApp.h.

---

Constructor & Destructor Documentation

vrj::OpenSGApp::OpenSGApp

(

vrj::Kernel *

kern = NULL

)

[inline]

Definition at line 88 of file OpenSGApp.h.

      : GlApp(kern)
   {
      ;
   }

virtual vrj::OpenSGApp::~OpenSGApp

(

)

[inline, virtual]

Definition at line 94 of file OpenSGApp.h.

   {
      ;
   }

---

Member Function Documentation

virtual void vrj::OpenSGApp::initScene

(

)

[pure virtual]

Scene initialization function.

User code for initializing the OpenSG scene should be placed here.

Referenced by apiInit().

virtual OSG::NodePtr vrj::OpenSGApp::getScene

(

)

[pure virtual]

Get the OpenSG Scene root.

Returns:

NodePtr to the root of the scene to render.

Referenced by apiInit(), and draw().

void vrj::OpenSGApp::init

(

)

[inline, virtual]

Initializes OpenSG for drawing.

If overridden, the overriding method MUST call this method.

Reimplemented from vrj::App.

Definition at line 160 of file OpenSGApp.h.

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

{
   vprDEBUG_OutputGuard(vprDBG_ALL, vprDBG_VERB_LVL,
                        "vrj::OpenSGApp::init() entered.\n",
                        "vrj::OpenSGApp::init() exited.\n");

   GlApp::init();

   // XXX: Complete initialization
   // if(!osgInitAlreadyCalled())
   OSG::osgInit(0,0);                  // Binds to primordial thread

#if 0
   // Work around to disable display list caching
   OSG::FieldContainerPtr pProto = OSG::Geometry::getClassType().getPrototype();
   OSG::GeometryPtr pGeoProto = OSG::GeometryPtr::dcast(pProto);

   if(pGeoProto != OSG::NullFC)
   {
       pGeoProto->setDlistCache(false);
   }
#endif

   OSG_MAIN_ASPECT_ID = OSG::Thread::getAspect();   // Gets the base aspect id to use
}

void vrj::OpenSGApp::apiInit

(

)

[inline, virtual]

Initializes OpenSG.

Make sure to call initScene if you override this function. If a derived class overrides this method, the overriding function MUST call OpenSGApp::apiInit().

Reimplemented from vrj::App.

Definition at line 186 of file OpenSGApp.h.

References getScene(), and initScene().

{
   vprDEBUG_OutputGuard(vprDBG_ALL, vprDBG_VERB_LVL,
                        "vrj::OpenSGApp::apiInit() entered.\n",
                        "vrj::OpenSGApp::apiInit() exited.\n");

   this->initScene();
   vprASSERT(getScene() != OSG::NullFC);
}

void vrj::OpenSGApp::exit

(

)

[inline, virtual]

Shuts down OpenSG.

If overridden, the overriding method call this method.

Reimplemented from vrj::App.

Definition at line 196 of file OpenSGApp.h.

{
   vprDEBUG_OutputGuard(vprDBG_ALL, vprDBG_VERB_LVL,
                        "vrj::OpenSGApp::exit() entered.\n",
                        "vrj::OpenSGApp::exit() exited.\n");

   OSG::osgExit();
}

void vrj::OpenSGApp::contextInit

(

)

[inline, virtual]

Called once per context at context creation.

If user code overrides these functions, the overriding functions MUST call these methods.

Reimplemented from vrj::GlApp.

Definition at line 206 of file OpenSGApp.h.

References vrj::OpenSGApp::context_data::mBackground, vrj::OpenSGApp::context_data::mCamera, vrj::OpenSGApp::context_data::mContextThreadInitialized, vrj::OpenSGApp::context_data::mOsgThread, vrj::OpenSGApp::context_data::mRenderAction, vrj::OpenSGApp::context_data::mViewport, vrj::OpenSGApp::context_data::mWin, and OSG_MAIN_ASPECT_ID.

{
   vprDEBUG_OutputGuard(vprDBG_ALL, vprDBG_VERB_LVL,
                        "vrj::OpenSGApp::contextInit() entered.\n",
                        "vrj::OpenSGApp::contextInit() exited.\n");

   context_data* c_data = &(*mContextData);  // Context specific data. Should be one copy per context

   // Check for thread initialized
   // This will only happen for the first initialized context per pipe
   if(!c_data->mContextThreadInitialized)
   {
      c_data->mContextThreadInitialized = true;

      char thread_name_buffer[255];
      sprintf(thread_name_buffer, "vprThread:%d",
              vpr::Thread::self()->getTID());
      c_data->mOsgThread = OSG::ExternalThread::get(thread_name_buffer);
      if(!(c_data->mOsgThread->isInitialized()))
      {
         c_data->mOsgThread->initialize(OSG_MAIN_ASPECT_ID);     // XXX: In future this might need to be different thread
      }
   }

   // Allocate OpenSG stuff
   c_data->mWin        = OSG::PassiveWindow::create();
   c_data->mViewport   = OSG::PassiveViewport::create();
   c_data->mBackground = OSG::PassiveBackground::create();
   c_data->mCamera     = OSG::MatrixCamera::create();

   // Setup the viewport
   OSG::beginEditCP(c_data->mViewport);
      c_data->mViewport->setLeft(0);
      c_data->mViewport->setRight(1);
      c_data->mViewport->setBottom(0);
      c_data->mViewport->setTop(1);
      c_data->mViewport->setCamera(c_data->mCamera);
      c_data->mViewport->setBackground(c_data->mBackground);
   OSG::endEditCP  (c_data->mViewport);

   // Setup the Window
   OSG::beginEditCP(c_data->mWin);
      c_data->mWin->addPort(c_data->mViewport);
   OSG::endEditCP  (c_data->mWin);

   // Setup the camera
   OSG::beginEditCP(c_data->mCamera);
      c_data->mCamera->setNear(0.1);
      c_data->mCamera->setFar (10000);
   OSG::endEditCP(c_data->mCamera);

   // Could actually make one of these per thread instead of context.
   c_data->mRenderAction = OSG::RenderAction::create();
   // c_data->mRenderAction->setAutoFrustum(false);         // Turn off auto frustum

   // Initialize OpenSG's OpenGL state

   c_data->mWin->init();
}

void vrj::OpenSGApp::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 266 of file OpenSGApp.h.

References vrj::OpenSGApp::context_data::mWin.

{
   context_data* c_data = &(*mContextData);
   c_data->mWin->frameInit();
}

void vrj::OpenSGApp::contextPostDraw

(

)

[inline, virtual]

Function that is called upon exit of the context after rendering.

Precondition:

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

Reimplemented from vrj::GlApp.

Definition at line 272 of file OpenSGApp.h.

References vrj::OpenSGApp::context_data::mWin.

{
   context_data* c_data = &(*mContextData);
   c_data->mWin->frameExit();
}

void vrj::OpenSGApp::draw

(

)

[inline, virtual]

Function that renders the scene.

Override this function with the user rendering routine.

Precondition:

OpenGL state has correct transformation and buffer selected.

Postcondition:

The current scene has been drawn.

Implements vrj::GlApp.

Definition at line 278 of file OpenSGApp.h.

References vrj::GlDrawManager::currentUserData(), vrj::GlApp::getDrawManager(), vrj::Projection::getFrustum(), vrj::GlUserData::getProjection(), getScene(), vrj::Projection::getViewMatrix(), vrj::OpenSGApp::context_data::mCamera, vrj::OpenSGApp::context_data::mRenderAction, vrj::OpenSGApp::context_data::mViewport, vrj::OpenSGApp::context_data::mWin, 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.

{
   vprDEBUG_OutputGuard(vprDBG_ALL, vprDBG_HVERB_LVL,
                        "vrj::OpenSGApp::draw() entered.\n",
                        "vrj::OpenSGApp::draw() exited.\n");

   glClear(GL_DEPTH_BUFFER_BIT);
   glPushAttrib(GL_ALL_ATTRIB_BITS);

   context_data* c_data = &(*mContextData);

   vrj::GlDrawManager* drawMan =
      dynamic_cast<vrj::GlDrawManager*>(this->getDrawManager());
   vprASSERT(drawMan != NULL);
   vrj::GlUserData* userData = drawMan->currentUserData();

   // Copy the matrix
   vrj::Projection* project = userData->getProjection();
   vrj::Frustum vrj_frustum = userData->getProjection()->getFrustum();

   const float* vj_proj_view_mat = project->getViewMatrix().mData;
   OSG::Matrix frustum_matrix, view_xform_mat;
   view_xform_mat.setValue(vj_proj_view_mat);

   OSG::MatrixFrustum(frustum_matrix,
                      vrj_frustum[vrj::Frustum::VJ_LEFT],
                      vrj_frustum[vrj::Frustum::VJ_RIGHT],
                      vrj_frustum[vrj::Frustum::VJ_BOTTOM],
                      vrj_frustum[vrj::Frustum::VJ_TOP],
                      vrj_frustum[vrj::Frustum::VJ_NEAR],
                      vrj_frustum[vrj::Frustum::VJ_FAR]);

   OSG::Matrix full_view_matrix = frustum_matrix;
   full_view_matrix.mult(view_xform_mat);   // Compute complete projection matrix

   // Setup the camera
   OSG::beginEditCP(c_data->mCamera);
      c_data->mCamera->setNear(vrj_frustum[vrj::Frustum::VJ_NEAR]);
      c_data->mCamera->setFar(vrj_frustum[vrj::Frustum::VJ_FAR]);
      c_data->mCamera->setProjectionMatrix( frustum_matrix );  // Set projection matrix
      c_data->mCamera->setModelviewMatrix( view_xform_mat );   // Set modelview matrix
   OSG::endEditCP(c_data->mCamera);

   // Setup the viewport
   OSG::beginEditCP(c_data->mViewport);
      c_data->mViewport->setRoot(getScene());
   OSG::endEditCP  (c_data->mViewport);

   // --- Trigger the draw --- //

   // Push the matrix so that drawing after this is not affected by the scene
   // graph.
   glMatrixMode(GL_PROJECTION);
   glPushMatrix();
   glMatrixMode(GL_MODELVIEW);
   glPushMatrix();
      c_data->mWin->render(c_data->mRenderAction);
   glPopMatrix();
   glMatrixMode(GL_PROJECTION);
   glPopMatrix();
   glMatrixMode(GL_MODELVIEW);

   glPopAttrib();    // Pop the attribute store

   FINFO(("Frame done on Window %lx.\n", c_data->mWin.getCPtr() ));
}

virtual void vrj::OpenSGApp::bufferPreDraw

(

)

[inline, virtual]

Called once per frame, per buffer (basically context).

This is needed so that we can use subviewports.

Reimplemented from vrj::GlApp.

Definition at line 147 of file OpenSGApp.h.

   {
      glClearColor(0.0, 0.0, 0.0, 0.0);
      glClear(GL_COLOR_BUFFER_BIT);
   }

---

Member Data Documentation

vrj::GlContextData<context_data> vrj::OpenSGApp::mContextData [protected]

OpenSG context data.

Definition at line 154 of file OpenSGApp.h.

OSG::UInt32 vrj::OpenSGApp::OSG_MAIN_ASPECT_ID [protected]

Definition at line 156 of file OpenSGApp.h.

Referenced by contextInit(), and init().

---

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

• OpenSGApp.h

---