OMK::Vis::OgreVis Class Reference

Specialization of VisBase for the Ogre3D library. More...

#include <OMKOgreVis.h>

Inheritance diagram for OMK::Vis::OgreVis:

[legend]Collaboration diagram for OMK::Vis::OgreVis:

[legend]List of all members.

Public Member Functions
const Ogre::Root &	getRoot (void) const
	returns a const reference to the Ogre3D root
Ogre::Root &	touchRoot (void) const
	returns a reference to the Ogre3D root
Private Member Functions
	DECLARE_OBJECT_FACTORY (OgreVis)
bool	ogreInitialisation (const std::string &pluginsFile, const std::string &configurationFile, const std::string &resourcesFile, const std::string &sceneManagerType, const std::string &windowName)
	initialises Ogre3D, using the parameters found in ogre.cfg or by displaying a configuration window if there is no ogre.cfg available.
void	createSceneManager (const std::string &sceneManagerType)
	creates a ST_GENERIC SceneManager named "SceneManager"
void	createResourceListener (void)
	not implemented yet
void	addResourceLocations (const std::string &resourcesFile)
	add the resources path given in the resources.cfg file
void	initResources (void)
	initialises all the resource groups
void	loadSceneFile (const std::string &resourceGroupName, const std::string &sceneFileName)
	load the dotScene file of configuration parameters "SceneFile" and resource group "ResourceGroup"
const std::string &	initCamera (const std::string &cameraName)
	initialises the ogre camera of name cameraName if no camera was specified by the configuration parameter "Camera" it creates a default camera named "camera0" positioned at (0,0,0), looking at (0,0,-1), with (1,1000) clipping planes return the name of the created camera
void	createViewport (const std::string &cameraName)
	creates a default viewport of colour (0.5,0.5,0.5)
Inherited
virtual void	computeParameters ()
	Compute the new picture to display.
Loaders
virtual bool	loadParameters (const ConfigurationParameterDescriptor *node)
	Configuration parameters loader of OgreVis.
Private Attributes
Ogre::Root *	_root
	Ogre3D root, unique point of access to the Ogre3D scene organization.

---

Detailed Description

Specialization of VisBase for the Ogre3D library.

Author:

Michaël Rouillé, bunraku <michael.rouille@irisa.fr>

This Simulated Object initialises Ogre3D, creates default window/viewport/camera and manages the visual objects and animators creation and updates

User parameters :

• OgreHome
• PluginsCfg
• ConfigFile
• ResourceGroup
• SceneFile

See The visualisation of OpenMASK with Ogre.

Definition at line 51 of file OMKOgreVis.h.

---

Member Function Documentation

OMK::Vis::OgreVis::DECLARE_OBJECT_FACTORY

(

OgreVis

)

[private]

const Ogre::Root & OMK::Vis::OgreVis::getRoot

(

void

)

const [inline]

returns a const reference to the Ogre3D root

Definition at line 122 of file OMKOgreVis.h.

References _root.

Referenced by OMK::Inp::BoundingBoxExtension::action(), and OMK::Inp::DistributedCameraListener::readConfigurationParameters().

                {
                        return *_root ;
                }

Ogre::Root & OMK::Vis::OgreVis::touchRoot

(

void

)

const [inline]

returns a reference to the Ogre3D root

Definition at line 131 of file OMKOgreVis.h.

Referenced by OMK::Inp::SceneDetailsExtension::action(), OMK::Inp::InputExtension::createOISInputSystem(), OMK::Inp::DistributedCameraListener::finish(), OMK::Inp::DistributedCameraListener::init(), OMK::Inp::InputExtension::initOIS(), OMK::Vis::OgreObjectScene::loadGeometry(), OMK::Vis::CameraBaseExtension::retreiveCamera(), OMK::Inp::DebugOverlayExtension::updateStats(), and OMK::Vis::OgreObject::~OgreObject().

                {
                        return const_cast < Ogre::Root& > ( *_root ) ;
                }

void OgreVis::computeParameters

(

)

[private, virtual]

Compute the new picture to display.

This method loops in the list of visual objects to ask to them to update their display.

Reimplemented from OMK::Vis::VisBase.

Definition at line 204 of file OMKOgreVis.cpp.

References _root, and OMK::Vis::VisBase::computeParameters().

{
        VisBase::computeParameters() ;

        //Allow platform to pump/create/etc messages/events once per frame 
        Ogre::WindowEventUtilities::messagePump( ) ; 
        _root->renderOneFrame() ;
}

bool OgreVis::loadParameters

(

const ConfigurationParameterDescriptor *

node

)

[private, virtual]

Configuration parameters loader of OgreVis.

Parameters:

[in]

node

the root node of the configuration parameter.

Returns:

true if all needed parameters can be read.

Reads in the configuration node the values to set the attributs. Reads the parameters to create visual objects and animators.

Reimplemented from OMK::ExtensibleSimulatedObject.

Definition at line 85 of file OMKOgreVis.cpp.

References _root, createViewport(), OMK::Vis::debugMsg(), OMK::ParametersAccessor::get(), initCamera(), OMK::ExtensibleSimulatedObject::loadParameters(), loadSceneFile(), ogreInitialisation(), OMERROR, OMK_DEBUG_VIS, and OMTRACEID.

{
        bool ok( VisBase::loadParameters( node ) );

        // Retrieve the plugins for Ogre
        std::string pluginsFile ;
        if( ParametersAccessor::get( node, "OgreHome", pluginsFile ) )
        {
#if defined _MSC_VER
                // Windows
#  if defined NDEBUG 
                pluginsFile += "\\bin\\release\\Plugins.cfg" ;
#  else // !defined NDEBUG 
                pluginsFile += "\\bin\\debug\\Plugins.cfg" ;
#  endif
#else
    // Linux 
    pluginsFile += "/lib/OGRE/Plugins.cfg" ;
#endif
        }
        else if( !ParametersAccessor::get( node, "PluginsCfg", pluginsFile ) )
        {
                OMERROR( "Error for " << debugMsg( this ) << std::endl
                        << ">>> :-( Unable to determine which configuration must be used for Ogre." << std::endl
                        << "One of these two fields, 'OgreHome' or 'PluginsCfg', must be set." << std::endl
                        << "The path to the Ogre folder is defined in 'OgreHome' like this : OgreHome \"${OGRE_HOME}\"" << std::endl
                        << "Or the configuration file path is defined in 'OgrePluginsCfg' like this : PluginsCfg \"${OGRE_HOME}/lib/OGRE/plugins.cfg\"" << std::endl
                        << "See documentation" ) ;
                ok = false ;
        }

        if ( ok )
        {
                // Retrieve the configuration file
                std::string configFile( "ogre.cfg" ) ;
                if( !ParametersAccessor::get( node, "ConfigFile", configFile ) )
                {
                        OMTRACEID( OMK_DEBUG_VIS, "Warning for " << debugMsg( this ) << std::endl
                                << ">>> :-| no configuration file provided, will use \"ogre.cfg\" by default" ) ; 
                }

                // Retrieve the resource configuration
                std::string resourcesFile( "resources.cfg" ) ;
                if( !ParametersAccessor::get( node, "ResourcesFile", resourcesFile ) )
                {
                        OMTRACEID( OMK_DEBUG_VIS, "Warning for " << debugMsg( this ) << std::endl
                                << ">>> :-| no resources file provided, will use \"resources.cfg\" by default" ) ; 
                }

                // Retrieve the resource group name
                std::string resourceGroupName( "General" ) ; // default value
                if( !ParametersAccessor::get( node, "ResourceGroup", resourceGroupName ) )
                {
                        OMTRACEID( OMK_DEBUG_VIS, "Warning for " << debugMsg( this ) << std::endl
                                << ">>> :-| no resource group name provided, will use \"General\" by default" ) ; 
                }

                // Retrieve scene file name
                std::string sceneFileName ;
                if( !ParametersAccessor::get( node, "SceneFile", sceneFileName ) )
                {
                        OMTRACEID( OMK_DEBUG_VIS, "Warning for " << debugMsg( this ) << std::endl
                                << ">>> :-| no scene file name provided" ) ; 
                }

                // Retrieve camera name
                std::string cameraName ;
                if( !ParametersAccessor::get( node, "Camera", cameraName ) )
                {
                        OMTRACEID( OMK_DEBUG_VIS, "Warning for " << debugMsg( this ) << std::endl
                                << ">>> :-| no camera name provided" ) ; 
                }

                // Retrieve sceneManagerType
                std::string sceneManagerType( "DefaultSceneManager" ) ;
                if( !ParametersAccessor::get( node, "SceneManagerType", sceneManagerType ) )
                {
                        OMTRACEID( OMK_DEBUG_VIS, "Warning for " << debugMsg( this ) << std::endl
                                << ">>> :-| no SceneManagerType provided" ) ; 
                }

                // Retrieve windowName
                std::string windowName( "Ogre Window" ) ;
                if( !ParametersAccessor::get( node, "WindowName", windowName ) )
                {
                        OMTRACEID( OMK_DEBUG_VIS, "Warning for " << debugMsg( this ) << std::endl
                                << ">>> :-| no WindowName provided" ) ; 
                }

   // createLog 

                // OGRE initialisation
                ok = ogreInitialisation( pluginsFile, configFile, resourcesFile, sceneManagerType, windowName ) ;
                if ( ok )
                {
                        // load the dotScene file of configuration parameters "SceneFile" 
                        // and resource group "ResourceGroup"
                        loadSceneFile( resourceGroupName, sceneFileName ) ;

                        if ( _root->getAutoCreatedWindow()->getNumViewports() == 0 )
                        {
                                // try to initialise the camera named "Camera"
                                // if cameraName was not specified a default camera is created
                                cameraName = initCamera( cameraName ) ;


                                // creates a default viewport of colour (0.5,0.5,0.5)
                                createViewport( cameraName ) ;
                        }
                }
        }

        return ok ;
}

bool OgreVis::ogreInitialisation	(	const std::string &	pluginsFile,
		const std::string &	configurationFile,
		const std::string &	resourcesFile,
		const std::string &	sceneManagerType,
		const std::string &	windowName
	)			[private]

initialises Ogre3D, using the parameters found in ogre.cfg or by displaying a configuration window if there is no ogre.cfg available.

Definition at line 217 of file OMKOgreVis.cpp.

References _root, addResourceLocations(), createResourceListener(), createSceneManager(), and initResources().

Referenced by loadParameters().

{
        bool initialised( false ) ;

        // creation of Ogre Root
        _root = new Ogre::Root( pluginsFile, configurationFile, "" ) ;

        // add resource locations
        addResourceLocations( resourcesFile );

        // Show the configuration dialog and initialise the system
        // You can skip this and use root.restoreConfig() to load configuration
        // settings if you were sure there are valid ones saved in ogre.cfg
        if( ( _root->restoreConfig() == true ) || ( _root->showConfigDialog() == true ) )
        {
                // If returned true, user clicked OK so initialise
                // Here we choose to let the system create a default rendering window by passing 'true'
                _root->initialise( true, windowName ) ;

                // creates a sceneManager named "sceneManager" of type ST_GENERIC
                createSceneManager( sceneManagerType ) ;

                // Set default mipmap level (NB some APIs ignore this)
                TextureManager::getSingleton().setDefaultNumMipmaps( 5 ) ;

                // Create any resource listeners (for loading screens)
                createResourceListener() ;

                // Initialise resources
                initResources();

#if !defined NDEBUG 
                // Initialise the trace output to the console
                OBT::Singleton<OBT::Tracer>::getInstance().setOutput( new LogOutput, true ) ;
#endif

                initialised = true ;
        }

        return initialised ;
}

void OgreVis::createSceneManager

(

const std::string &

sceneManagerType

)

[private]

creates a ST_GENERIC SceneManager named "SceneManager"

Definition at line 267 of file OMKOgreVis.cpp.

References _root, and OMFATALERROR.

Referenced by ogreInitialisation().

{
        try
        {
                // Create the SceneManager
                _root->createSceneManager( sceneManagerType, "sceneManager" ) ;
        }
        catch ( Ogre::ItemIdentityException& e )
        {
                OMFATALERROR( "Scene manager type : " << sceneManagerType << " does not exist" << std::endl 
                        << e.getFullDescription() ) ;
        }
}

void OgreVis::createResourceListener

(

void

)

[private]

not implemented yet

Definition at line 285 of file OMKOgreVis.cpp.

Referenced by ogreInitialisation().

{
}

void OgreVis::addResourceLocations

(

const std::string &

resourcesFile

)

[private]

add the resources path given in the resources.cfg file

Definition at line 293 of file OMKOgreVis.cpp.

Referenced by ogreInitialisation().

{
        // Load resource paths from config file
        ConfigFile configFile ;
        configFile.load( resourcesFile ) ;

        // Go through all sections & settings in the file
        ConfigFile::SectionIterator sectionIterator( configFile.getSectionIterator() ) ;

        String sectionName ;
        String typeName ;
        String archName ;
        while ( sectionIterator.hasMoreElements() == true )
        {
                sectionName = sectionIterator.peekNextKey();
                ConfigFile::SettingsMultiMap* settings( sectionIterator.getNext() ) ;
                for ( ConfigFile::SettingsMultiMap::iterator i( settings->begin() ) ; i != settings->end(); ++i )
                {
                        typeName = i->first ;
                        archName = i->second ;
                        ResourceGroupManager::getSingleton().addResourceLocation( archName, typeName, sectionName ) ;
                }
        }
}

void OgreVis::initResources

(

void

)

[private]

initialises all the resource groups

Definition at line 322 of file OMKOgreVis.cpp.

Referenced by ogreInitialisation().

{
        ResourceGroupManager::getSingleton().initialiseAllResourceGroups();
}

void OgreVis::loadSceneFile	(	const std::string &	resourceGroupName,
		const std::string &	sceneFileName
	)			[private]

load the dotScene file of configuration parameters "SceneFile" and resource group "ResourceGroup"

Definition at line 331 of file OMKOgreVis.cpp.

References _root, OMK::Vis::debugMsg(), OMK_DEBUG_VIS, and OMTRACEID.

Referenced by loadParameters().

{
        if ( sceneFileName.empty() == false )
        {
                // load the scene associated to the simulated object OgreVis
                OBT::Singleton<dsi::dotSceneLoader>::getInstance().load
                        (       sceneFileName, 
                                resourceGroupName, 
                                _root->getSceneManager( "sceneManager" ), 
                                _root->getAutoCreatedWindow(), 
                                NULL, 
                                false, 
                                false, 
                                true ) ;

                // check for load errors
                dsi::dotSceneInfo::itLoadLog it( dsi::dotSceneInfo::getSceneLoadingLog() ) ;
                String errs ;
                while ( it.hasMoreElements() )
                {
                        errs += it.getNext() + "\n";
                }
                if ( errs != StringUtil::BLANK )
                {
                        OMTRACEID( OMK_DEBUG_VIS, "Warning for " << debugMsg( this ) << std::endl
                                << ">>> :-| errors occured during scene loading\n" << errs ) ;
                }
        }
}

const std::string & OgreVis::initCamera

(

const std::string &

cameraName

)

[private]

initialises the ogre camera of name cameraName if no camera was specified by the configuration parameter "Camera" it creates a default camera named "camera0" positioned at (0,0,0), looking at (0,0,-1), with (1,1000) clipping planes return the name of the created camera

Definition at line 365 of file OMKOgreVis.cpp.

References _root.

Referenced by loadParameters().

{
        Ogre::SceneManager* sceneManager( _root->getSceneManager( "sceneManager" ) ) ;
        // creates a default camera if cameraName does not exist        
        if ( sceneManager->hasCamera( cameraName ) == false )
        {

                // Create the camera
                Camera* camera( sceneManager->createCamera( "camera0" ) ) ;
                // Position it at 0, 0, 0
                camera->setPosition( Vector3( 0, 0, 0 ) ) ;
                // Look back along -Z
                camera->lookAt( Vector3( 0, 0, -1 ) ) ;
                camera->setNearClipDistance( 1 ) ;
                camera->setFarClipDistance( 5000 ) ;
                
                //Put Camera on Node, useful for SoundListener 
                SceneNode* cameraNode( sceneManager->getRootSceneNode()->createChildSceneNode( "CameraNode" ) ) ;
                cameraNode->attachObject( camera );
                return camera->getName() ;
        }
        return cameraName ;
}

void OgreVis::createViewport

(

const std::string &

cameraName

)

[private]

creates a default viewport of colour (0.5,0.5,0.5)

Definition at line 393 of file OMKOgreVis.cpp.

References _root.

Referenced by loadParameters().

{
        Ogre::Camera* camera( _root->getSceneManager( "sceneManager" )->getCamera( cameraName ) ) ;

        // Create one viewport, entire window
        Viewport* viewport( _root->getAutoCreatedWindow()->addViewport( camera ) ) ;
        viewport->setBackgroundColour( ColourValue( 0.5, 0.5, 0.5 ) ) ;

        // Alter the camera aspect ratio to match the viewport
        camera->setAspectRatio( Real( viewport->getActualWidth() ) / Real( viewport->getActualHeight() ) ) ;
}

---

Member Data Documentation

Ogre::Root* OMK::Vis::OgreVis::_root [private]

Ogre3D root, unique point of access to the Ogre3D scene organization.

Definition at line 115 of file OMKOgreVis.h.

Referenced by computeParameters(), createSceneManager(), createViewport(), getRoot(), initCamera(), loadParameters(), loadSceneFile(), and ogreInitialisation().

---