source: osgVisual/src/core/visual_core.cpp @ 131

/* -*-c++-*- osgVisual - Copyright (C) 2009-2010 Torben Dannhauer
 *
 * This library is based on OpenSceneGraph, open source and may be redistributed and/or modified under 
 * the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
 * (at your option) any later version.  The full license is in LICENSE file
 * included with this distribution, and on the openscenegraph.org website.
 *
 * osgVisual requires for some proprietary modules a license from the correspondig manufacturer.
 * You have to aquire licenses for all used proprietary modules.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * OpenSceneGraph Public License for more details.
*/


#include <visual_core.h>

using namespace osgVisual;

visual_core::visual_core(osg::ArgumentParser& arguments_) : arguments(arguments_)
{
        OSG_NOTIFY( osg::ALWAYS ) << "visual_core instantiated." << std::endl;
}

visual_core::~visual_core(void)
{
        OSG_NOTIFY( osg::ALWAYS ) << "visual_core destroyed." << std::endl;
}

void visual_core::initialize()
{
        OSG_NOTIFY( osg::ALWAYS ) << "Initialize visual_core..." << std::endl;

        // Configure osg to use KdTrees
        osgDB::Registry::instance()->setBuildKdTreesHint(osgDB::ReaderWriter::Options::BUILD_KDTREES);

        // Setup pathes
        osgDB::Registry::instance()->getDataFilePathList().push_back( "D:\\DA\\osgVisual\\models" );
        
        // Setup viewer
        viewer = new osgViewer::Viewer(arguments);

        // Setup coordinate system node
        rootNode = new osg::CoordinateSystemNode;       // todo memleakf
        rootNode->setEllipsoidModel(new osg::EllipsoidModel());

        // Test memory leak (todo)
        double* test = new double[1000];

        #ifdef USE_SPACENAVIGATOR
                mouse = NULL;
        #endif

        //osg::DisplaySettings::instance()->setNumOfDatabaseThreadsHint( 8 );

        // Show model
        viewer->setSceneData( rootNode );

        osg::Group* distortedSceneGraph = NULL;
#ifdef USE_DISTORTION
        // Initialize distortion
        OSG_NOTIFY( osg::ALWAYS ) << "Using distortion." << std::endl;
        distortion = new visual_distortion( viewer, arguments );
        distortion->initialize( rootNode, viewer->getCamera()->getClearColor() );
        distortedSceneGraph = distortion->getDistortedSceneGraph();
#endif

#ifdef USE_SKY_SILVERLINING
        // Initialize sky
        sky = new visual_skySilverLining( viewer );
        sky->init(distortedSceneGraph, rootNode);       // Without distortedSceneGraph=NULL
#endif

        // Initialize DataIO interface
        visual_dataIO::getInstance()->init(viewer, arguments);

        // Add manipulators for user interaction - after dataIO to be able to skip it in slaves.
        addManipulators();

        loadTerrain(arguments);

        // create the windows and run the threads.
        viewer->realize();

        // setup scenery
        setupScenery();

        // parse Configuration file
        parseConfigFile(arguments);

        // All modules are initialized - now check arguments for any unused parameter.
        checkCommandlineArgumentsForFinalErrors();

        // Run visual main loop
        mainLoop();
}

void visual_core::mainLoop()
{
        // run main loop
        while( !viewer->done() )
    {
                // next frame please....
        viewer->advance();

                /*double hat, hot, lat, lon, height;
                util::getWGS84ofCamera( viewer->getCamera(), rootNode, lat, lon, height);
                if (util::queryHeightOfTerrain( hot, rootNode, lat, lon) && util::queryHeightAboveTerrainInWGS84( hat, rootNode, lat, lon, height ) )
                        OSG_NOTIFY( osg::ALWAYS ) << "HOT is: " << hot << ", HAT is: " << hat << std::endl;*/
        
                // perform all queued events
                viewer->eventTraversal();

                // update the scene by traversing it with the the update visitor which will
        // call all node update callbacks and animations.
        viewer->updateTraversal();
                
        // Render the Frame.
        viewer->renderingTraversals();

    }   // END WHILE
}

void visual_core::shutdown()
{
        OSG_NOTIFY( osg::ALWAYS ) << "Shutdown visual_core..." << std::endl;

        // Shutdown Dbug HUD
        if(hud.valid())
                hud->shutdown();
        // Unset scene data
        viewer->setSceneData( NULL );

#ifdef USE_SKY_SILVERLINING
        // Shutdown sky
        if( sky.valid() )
                sky->shutdown();
#endif

#ifdef USE_DISTORTION
        // Shutdown distortion
        if( distortion.valid() )
                distortion->shutdown();
#endif

        // Shutdown data
        rootNode = NULL;

        // Shutdown dataIO
        visual_dataIO::getInstance()->shutdown();

        
#ifdef USE_SPACENAVIGATOR
        //Delete SpaceMouse driver
        if(mouse)
        {
                mouse->shutdown();
                delete mouse;
        }
#endif

        // Destroy osgViewer
        viewer = NULL;
}

bool visual_core::loadTerrain(osg::ArgumentParser& arguments_)
{
        osg::ref_ptr<osg::Node> model = osgDB::readNodeFiles(arguments_);
        if( model.valid() )
        {
        rootNode->addChild( model.get() );
                return true;
        }
        else
        {
        OSG_NOTIFY( osg::FATAL ) << "Load terrain: No data loaded" << std::endl;
        return false;
    }    

        return false;
}

void visual_core::addManipulators()
{
        if(!visual_dataIO::getInstance()->isSlave()) // set up the camera manipulators if not slave.
    {
        osg::ref_ptr<osgGA::KeySwitchMatrixManipulator> keyswitchManipulator = new osgGA::KeySwitchMatrixManipulator;

        keyswitchManipulator->addMatrixManipulator( '1', "Trackball", new osgGA::TrackballManipulator() );
        keyswitchManipulator->addMatrixManipulator( '2', "Flight", new osgGA::FlightManipulator() );
        keyswitchManipulator->addMatrixManipulator( '3', "Terrain", new osgGA::TerrainManipulator() );
                nt = new osgGA::NodeTrackerManipulator();
                keyswitchManipulator->addMatrixManipulator( '4', "NodeTrackerManipulator", nt );
                
#ifdef USE_SPACENAVIGATOR
                // SpaceNavigator manipulator
                mouse = new SpaceMouse();
                mouse->initialize();
                mouseTrackerManip = new NodeTrackerSpaceMouse(mouse);
                mouseTrackerManip->setTrackerMode(NodeTrackerSpaceMouse::NODE_CENTER);
                mouseTrackerManip->setRotationMode(NodeTrackerSpaceMouse::ELEVATION_AZIM);
                mouseTrackerManip->setAutoComputeHomePosition( true );
                keyswitchManipulator->addMatrixManipulator( '5', "Spacemouse Node Tracker", mouseTrackerManip );
                keyswitchManipulator->addMatrixManipulator( '6', "Spacemouse Free (Airplane)", new FreeManipulator(mouse) );
#endif

                // objectMounted Manipulator for Camera control by Nodes
                objectMountedCameraManip = new objectMountedManipulator();
                keyswitchManipulator->addMatrixManipulator( '7', "Object mounted Camera", objectMountedCameraManip );

                // Animation path manipulator
        std::string pathfile;
        char keyForAnimationPath = '8';
        while (arguments.read("-p",pathfile))
        {
            osgGA::AnimationPathManipulator* apm = new osgGA::AnimationPathManipulator(pathfile);
            if (apm || !apm->valid()) 
            {
                unsigned int num = keyswitchManipulator->getNumMatrixManipulators();
                keyswitchManipulator->addMatrixManipulator( keyForAnimationPath, "Path", apm );
                keyswitchManipulator->selectMatrixManipulator(num);
                ++keyForAnimationPath;
            }
        }

        viewer->setCameraManipulator( keyswitchManipulator.get() );
    }   // If not Slave END

    // add the state manipulator
    viewer->addEventHandler( new osgGA::StateSetManipulator(rootNode->getOrCreateStateSet()) );
    
    // add the thread model handler
    viewer->addEventHandler(new osgViewer::ThreadingHandler);

    // add the window size toggle handler
    viewer->addEventHandler(new osgViewer::WindowSizeHandler);
        
    // add the stats handler
    viewer->addEventHandler(new osgViewer::StatsHandler);

    // add the help handler
    viewer->addEventHandler(new osgViewer::HelpHandler(arguments.getApplicationUsage()));

    // add the record camera path handler
    viewer->addEventHandler(new osgViewer::RecordCameraPathHandler);

    // add the LOD Scale handler
    viewer->addEventHandler(new osgViewer::LODScaleHandler);

    // add the screen capture handler
    viewer->addEventHandler(new osgViewer::ScreenCaptureHandler);
}

void visual_core::parseConfigFile(osg::ArgumentParser& arguments_)
{
        configFileValid = false;

        std::string filename;
        if( arguments.read("-c", filename) || arguments.read("--config", filename) )
        {
                OSG_ALWAYS << "Using configuration file.." << std::endl;
                if( osgDB::fileExists(filename) )
                {
                        configFileValid = false;
                        xmlDoc *doc = NULL;
                        xmlNode *root_element = NULL;
                        
                        doc = xmlReadFile(filename.c_str(), NULL, 0);
                        if (doc == NULL)
                        {
                                configFileValid = false;
                                OSG_ALWAYS << "visual_core::parseConfigFile() - ERROR: could not parse osgVisual config file" << filename  << std::endl;
                        }
                        else
                        {
                                //  Get the root element node
                                root_element = xmlDocGetRootElement(doc);

                                // Parse the XML document.
                                checkXMLNode(root_element);

                                // free the document
                                xmlFreeDoc(doc);;
                        }
                        // Free the global variables that may have been allocated by the parser.
                        xmlCleanupParser();

                        if(!configFileValid)
                                OSG_ALWAYS << "visual_core::parseConfigFile() - ERROR: XML file seems not to be a valid osgVisual configuration file!" << std::endl;

                }       // IF configfile exists
        }       // IF -c END
}

void visual_core::checkXMLNode(xmlNode * a_node)
{
  for (xmlNode *cur_node = a_node; cur_node; cur_node = cur_node->next)
        {
                std::string node_name=reinterpret_cast<const char*>(cur_node->name);
                if(cur_node->type == XML_ELEMENT_NODE && node_name == "osgvisualconfiguration")
                {
                        OSG_DEBUG << "XML node osgvisualconfiguration found" << std::endl;
                        configFileValid = true;
                        // Iterate to the next nodes to configure modules and scenery.
                        checkXMLNode(cur_node->children);               
                }

        if (cur_node->type == XML_ELEMENT_NODE && node_name == "module")
                {
                        OSG_DEBUG << "XML node module found" << std::endl;

                        parseModule(cur_node);
        
            //OSG_DEBUG << "node type=Element, name:" << cur_node->name << std::endl;
                        //OSG_DEBUG << "Processing children at " << cur_node->children << std::endl;
        }       // IF(module) END

                if (cur_node->type == XML_ELEMENT_NODE && node_name == "scenery")
                {
                        OSG_DEBUG << "XML node scenery found" << std::endl;

                        parseScenery(cur_node);
        
            //OSG_DEBUG << "node type=Element, name:" << cur_node->name << std::endl;
                        //OSG_DEBUG << "Processing children at " << cur_node->children << std::endl;
        }       // IF(scenery) END
    }   // FOR END
}

void visual_core::parseModule(xmlNode * a_node)
{
        OSG_ALWAYS << "parseModule()" << std::endl;

// Extract infos
        std::string name = "";
        bool enabled = false;

        xmlAttr  *attr = a_node->properties;
        while ( attr ) 
        { 
                std::string attr_name=reinterpret_cast<const char*>(attr->name);
                std::string attr_value=reinterpret_cast<const char*>(attr->children->content);
                if( attr_name == "name" )
                        name = reinterpret_cast<const char*>(attr->children->content);
                if( attr_name == "enabled" && attr_value== "yes" )
                        enabled = true;
                if( attr_name == "enabled" && attr_value== "no" )
                        enabled = false;

                OSG_ALWAYS << "Module '" << name << "' found. Enabled = " << enabled << std::endl;

                attr = attr->next; 
        } 

        // Pass the nodes to the corresponding modules...
        if(name == "core") this->config(a_node);

}

void visual_core::parseScenery(xmlNode * a_node)
{
        OSG_ALWAYS << "parseScenery()" << std::endl;
}

void visual_core::config(xmlNode * a_node)
{
        // Currently no configuration options fpr the core module are available.
}

bool visual_core::checkCommandlineArgumentsForFinalErrors()
{
        // Setup Application Usage
        arguments.getApplicationUsage()->setApplicationName(arguments.getApplicationName());
        arguments.getApplicationUsage()->setDescription(arguments.getApplicationName()+" is the new FSD visualization tool, written by Torben Dannhauer");
    arguments.getApplicationUsage()->setCommandLineUsage(arguments.getApplicationName()+" [options] Terrain_filename");
        arguments.getApplicationUsage()->addCommandLineOption("-h or --help","Display this information");

    // if user request help write it out to cout.
    if (arguments.read("-h") || arguments.read("--help"))
    {
        arguments.getApplicationUsage()->write(std::cout);
                //cause the viewer to exit and shut down clean.
        viewer->setDone(true);
    }

    // report any errors if they have occurred when parsing the program arguments.
    if (arguments.errors())
    {
        arguments.writeErrorMessages(std::cout);
                //cause the viewer to exit and shut down clean.
        viewer->setDone(true);
    }

         // any option left unread are converted into errors to write out later.
    arguments.reportRemainingOptionsAsUnrecognized();

    // report any errors if they have occurred when parsing the program arguments.
    if (arguments.errors())
    {
        arguments.writeErrorMessages(std::cout);
        return false;
    }
        return true;
}

void visual_core::setupScenery()
{
        // iterate manually through one frame to allow some modules like Sky_Silverlining to initialize properly before we configure it according to the scenery data.
        viewer->advance();
        viewer->eventTraversal();
        viewer->updateTraversal();
        viewer->renderingTraversals();

        // Sky settings:        
        sky->setTime(12,00,23);
        sky->setVisibility(50000);
        //addWindVolume( 0.0, 15000.0, 300.0, 90.0 );
        
        //sky->addCloudLayer( 0, 20000, 20000, 600.0, 0.0, 0.5, CUMULONIMBUS_CAPPILATUS );
        //sky->addCloudLayer( 1, 5000000, 5000000, 600.0, 7351.0, 0.2, CIRRUS_FIBRATUS );
        sky->addCloudLayer( 2, 50000, 50000, 600.0, 7351.0, 0.2, CIRROCUMULUS );
        sky->addCloudLayer( 3, 100000, 100000, 1300.0, 100.0, 0.07, CUMULUS_CONGESTUS );
        sky->addCloudLayer( 0, 10000, 10000, 1300.0, 4000.0, 0.90, STRATOCUMULUS );
        //cloudLayerSlots[1].cloudLayerPointer->SetPrecipitation(SilverLining::CloudLayer::SLEET, 25.0 );

        //testObj = new visual_object( rootNode, "testStab", objectMountedCameraManip );
        //testObj->setNewPosition( osg::DegreesToRadians(47.7123), osg::DegreesToRadians(12.84088), 600 );
        ///* using a huge cylinder to test position & orientation */
        //testObj->setGeometry( util::getDemoCylinder(5000.0, 20.0 ) );
        //testObj->addUpdater( new object_updater(testObj) );

        //osg::ref_ptr<visual_object> testObj2 = new visual_object( rootNode, "neuschwanstein" );       // todo memleak
        ////testObj2->setNewPosition( osg::DegreesToRadians(47.8123), osg::DegreesToRadians(12.94088), 600 );
        //testObj2->setNewPosition( osg::DegreesToRadians(47.557523564234), osg::DegreesToRadians(10.749646398595), 950 );
        //testObj2->loadGeometry( "../models/neuschwanstein.osgb" );
        ////testObj2->addUpdater( new object_updater(testObj2) );       // todo memleak

        osg::ref_ptr<visual_object> testObj3 = new visual_object( rootNode, "SAENGER1" );       // todo memleak
        testObj3->setNewPosition( osg::DegreesToRadians(47.8123), osg::DegreesToRadians(12.94088), 600 );
        testObj3->loadGeometry( "../models/saenger1.flt" );
        testObj3->addUpdater( new object_updater(testObj3) );   // todo memleak
        

        osg::ref_ptr<visual_object> testObj4 = new visual_object( rootNode, "SAENGER2" );       // todo memleak
        testObj4->setNewPosition( osg::DegreesToRadians(47.8123), osg::DegreesToRadians(12.94088), 650 );
        testObj4->loadGeometry( "../models/saenger2.flt" );
        testObj4->addUpdater( new object_updater(testObj4) );   // todo memleak
        testObj4->addLabel("testLabel", "LabelTest!!\nnächste Zeile :)",osg::Vec4(1.0f,0.25f,1.0f,1.0f));

        osg::ref_ptr<visual_object> testObj5 = new visual_object( rootNode, "SAENGER" );        // todo memleak
        testObj5->setNewPosition( osg::DegreesToRadians(47.8123), osg::DegreesToRadians(12.94088), 550 );
        testObj5->loadGeometry( "../models/saengerCombine.flt" );
        //testObj5->setScale( 2 );
        testObj5->addUpdater( new object_updater(testObj5) );   // todo memleak

#ifdef USE_SPACENAVIGATOR
        // Manipulatoren auf dieses Objekt binden (Primärobjekt)
        if (objectMountedCameraManip.valid())
                objectMountedCameraManip->setAttachedObject( testObj4 );
        if (mouseTrackerManip.valid())
        {
                mouseTrackerManip->setTrackNode( testObj4->getGeometry() );
                mouseTrackerManip->setMinimumDistance( 100 );
        }
#endif

        if(nt.valid())
        {
                osgGA::NodeTrackerManipulator::TrackerMode trackerMode = osgGA::NodeTrackerManipulator::NODE_CENTER;
                osgGA::NodeTrackerManipulator::RotationMode rotationMode = osgGA::NodeTrackerManipulator::ELEVATION_AZIM;
                nt->setTrackerMode(trackerMode);
                nt->setRotationMode(rotationMode);
                //nt->setAutoComputeHomePosition( true );
                nt->setMinimumDistance( 100 );
                nt->setTrackNode(testObj4->getGeometry());
                //nt->computeHomePosition();
                nt->setAutoComputeHomePosition( true );
                nt->setDistance( 250 );
        }


        // Load EDDF
        //std::string filename = "D:\\DA\\EDDF_test\\eddf.ive";
        //if( !osgDB::fileExists(filename) )
        //{
        //      OSG_NOTIFY(osg::ALWAYS) << "Warning: EDDF Model not loaded. File '" << filename << "' does not exist. Skipping.";
        //}
        //// read model
        //osg::ref_ptr<osg::Node> tmpModel = osgDB::readNodeFile( filename );
        //if (tmpModel.valid())
        //      rootNode->addChild( tmpModel );
        
 
        visual_draw2D::getInstance()->init( rootNode, viewer );
        //osg::ref_ptr<visual_hud> hud = new visual_hud();
        hud = new visual_debug_hud();
        hud->init( viewer, rootNode );
        
        

        //osg::ref_ptr<visual_draw3D> test = new visual_draw3D();
        //test->init( rootNode, viewer );

        //// Creating Testclasses
        //osg::ref_ptr<osgVisual::dataIO_transportContainer> test = new osgVisual::dataIO_transportContainer();
        //osg::ref_ptr<osgVisual::dataIO_executer> testEx = new osgVisual::dataIO_executer();
        //osg::ref_ptr<osgVisual::dataIO_slot> testSlot = new osgVisual::dataIO_slot();
        //test->setFrameID( 22 );
        //test->setName("ugamoep");
        //testEx->setexecuterID( osgVisual::dataIO_executer::IS_COLLISION );
        //testSlot->setVariableName(std::string("HalloName"));
        //testSlot->setdataDirection( osgVisual::dataIO_slot::TO_OBJ );
        //testSlot->setvarType( osgVisual::dataIO_slot::DOUBLE );
        //testSlot->setValue( 0.12345 );
        //test->addExecuter( testEx );
        //test->addSlot( testSlot );

        visual_dataIO::getInstance()->setSlotData("TestSlot1", osgVisual::dataIO_slot::TO_OBJ, 0.12345);
}