gzDynamicLoader.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDynamicLoader.h
// Module       : 
// Description  : Class definition of the gzDynamicLoader class
// Author       : Anders Modén      
// Product      : Gizmo3D 2.1.1
//      
// Copyright © 2003- Saab Training Systems AB, Sweden   
//          
// NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
//          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
//          usage in Game or VisSim development.
//
//
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  000311  Created file    
//
//******************************************************************************
#ifndef __GZ_DYNAMIC_LOADER_H__
#define __GZ_DYNAMIC_LOADER_H__

#include "gzGroup.h"
#include "gzThread.h"
#include "gzNodeOptimizer.h"

enum gzDynamicLoadingState
{ 
    GZ_DYNAMIC_LOADER_UNLOADED ,                // SYNC in NodeLock
    GZ_DYNAMIC_LOADER_LOADED ,                  // SYNC in NodeLock
    GZ_DYNAMIC_LOADER_REQUEST_LOAD,             // SYNC from thread
    GZ_DYNAMIC_LOADER_REQUEST_LOAD_CANCEL,      // SYNC from thread
    GZ_DYNAMIC_LOADER_IN_LOADING,               // ASYNC
    GZ_DYNAMIC_LOADER_IN_TRAVERSAL,             // No callback
    GZ_DYNAMIC_LOADER_REQUEST_UNLOAD,           // ASYNC
    GZ_DYNAMIC_LOADER_NOT_FOUND,                // ASYNC

};

class gzDynamicLoader;  // Forward decl

//******************************************************************************
// Class    : gzDynamicLoaderGlobalInfoInterface
//                                  
// Purpose  : Interface that notifies clients about loaded dynamic data from all instances.
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  021119  Created 
//                                  
//******************************************************************************
class gzDynamicLoaderGlobalInfoInterface 
{
public:

    GZ_GRAPH_EXPORT gzDynamicLoaderGlobalInfoInterface();

    GZ_GRAPH_EXPORT virtual ~gzDynamicLoaderGlobalInfoInterface();

    GZ_GRAPH_EXPORT virtual gzVoid onDynamicLoadState(gzDynamicLoadingState state,gzDynamicLoader *loader,gzNode *node);

private:

    friend class gzDynamicLoader;

    static  gzVoid notify(gzDynamicLoadingState state,gzDynamicLoader *loader,gzNode *node);

    static  gzList<gzDynamicLoaderGlobalInfoInterface>  s_subscribers;
};

//******************************************************************************
// Class    : gzDynamicLoaderInfoInterface
//                                  
// Purpose  : Interface that notifies clients about loaded dynamic data from subscribed instances.
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  021119  Created 
//                                  
//******************************************************************************
class gzDynamicLoaderInfoInterface
{
public:

    GZ_GRAPH_EXPORT gzDynamicLoaderInfoInterface();

    GZ_GRAPH_EXPORT virtual ~gzDynamicLoaderInfoInterface();

    GZ_GRAPH_EXPORT virtual gzVoid onDynamicLoadState(gzDynamicLoadingState state,gzDynamicLoader *loader,gzNode *node)=0;

private:

    friend class gzDynamicLoader;

    gzList<gzDynamicLoader> m_pendingSubscriptions;
};

//******************************************************************************
// Class    : gzDynamicLoader
//                                  
// Purpose  : An instance that loads data dynamically dependant on speed and 
//            direction of viewer
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// AMO  021119  Created 
//                                  
//******************************************************************************
class gzDynamicLoader : public gzGroup
{
public:

    GZ_GRAPH_EXPORT gzDynamicLoader(const gzString & name=GZ_EMPTY_STRING);

    GZ_GRAPH_EXPORT virtual ~gzDynamicLoader();

    GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface

    // ---------- loader interface --------------------------------------

    GZ_GRAPH_EXPORT gzVoid  setLoadState( gzBool load=TRUE );

    GZ_GRAPH_EXPORT gzVoid  setNodeURL(const gzString &name);

    GZ_GRAPH_EXPORT gzVoid  setLoadFlags(const gzSerializeAdapterFlags & flags );

    GZ_GRAPH_EXPORT gzVoid  setScale(gzReal scale=0);

    GZ_GRAPH_EXPORT gzVoid  setHPR(gzReal heading=0 , gzReal pitch=0 , gzReal roll=0);

    GZ_GRAPH_EXPORT gzVoid  waitForLoadedData();

    GZ_GRAPH_EXPORT gzBool  isLoaded();

    GZ_GRAPH_EXPORT gzBool  isInLoading();

    GZ_GRAPH_EXPORT gzBool  getLoadState();

    GZ_GRAPH_EXPORT gzVoid  useOptimizer(gzBool on);

    GZ_GRAPH_EXPORT gzVoid  setOptimizerFlags(const gzNodeOptimizeLevel & flags );

    GZ_GRAPH_EXPORT virtual gzVoid onNodeLoadState(gzNode *node,gzDynamicLoadingState state);

    GZ_GRAPH_EXPORT static  gzBool      isWorking();

    GZ_GRAPH_EXPORT static  gzDouble    getWorkDelay();

    GZ_GRAPH_EXPORT static  gzULong     getPendingWork();

    GZ_GRAPH_EXPORT static  gzVoid      boostLoaderWork();

    GZ_GRAPH_EXPORT static  gzVoid      unBoostLoaderWork();


    // ---------- Clone interface ---------------------------------------
    GZ_GRAPH_EXPORT virtual gzReference* clone() const;

    GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);
    GZ_GRAPH_EXPORT virtual gzVoid postTraverseAction( gzTraverseAction *actionclass , gzContext *context);
    GZ_GRAPH_EXPORT virtual gzBool isTraversable( gzTraverseAction *action , gzNode *node , gzULong index , gzContext *context );

    // ---------- Serializing -------------------------------------------

    GZ_GRAPH_EXPORT virtual gzVoid write(gzSerializeAdapter *adapter);
    GZ_GRAPH_EXPORT virtual gzVoid read(gzSerializeAdapter *adapter);
    GZ_GRAPH_EXPORT virtual gzULong getDataSize(gzSerializeAdapter *adapter) const;

    // ---------- Subscribing -------------------------------------------

    GZ_GRAPH_EXPORT gzVoid addSubscriber(gzDynamicLoaderInfoInterface *subscriber);
    GZ_GRAPH_EXPORT gzVoid removeSubscriber(gzDynamicLoaderInfoInterface *subscriber);
    

    GZ_PROPERTY_EXPORT(gzULong,     AttachID,       GZ_GRAPH_EXPORT);
    GZ_PROPERTY_EXPORT(gzDouble,    LoadPriority,   GZ_GRAPH_EXPORT);

protected:

    GZ_GRAPH_EXPORT gzVoid notifyLoadState(gzDynamicLoadingState state,gzDynamicLoader *loader,gzNode *node);

    friend class gzDynamicLoaderManager;

    // Atomic vars locked by gzNodeLock

    gzDynamicLoadingState   m_state:4;

    gzBool                  m_loadState:1;

    gzBool                  m_optimize:1;

    gzBool                  m_pendingWork:1;

    // Atomic vars locked by loader item

    gzString                m_nodeURL;

    gzSerializeAdapterFlags m_loadFlags;

    gzReal                  m_scale;

    gzReal                  m_heading;

    gzReal                  m_pitch;

    gzReal                  m_roll;

    gzNodeOptimizeLevel     m_optimizerFlags;

    gzList<gzDynamicLoaderInfoInterface>    m_subscribers;

private:

    static gzULong          s_pendingWork;

    static gzDouble         s_lastPingTime;

    static gzBool           s_isBoosted;
};

//******************************************************************************
// Class    : gzDynamicLoaderManager
//
// Purpose  : The manager for dynamic loaders.
//
// Notes    : -
//
// Revision History...
//
// Who  Date    Description
//
// AMO  021119  Created
//
//******************************************************************************
class gzDynamicLoaderManager : public gzThread
{
public:

    gzDynamicLoaderManager();

    virtual ~gzDynamicLoaderManager();
    
    GZ_GRAPH_EXPORT static  gzVoid startManager();

    GZ_GRAPH_EXPORT static  gzVoid stopManager();

    GZ_GRAPH_EXPORT static  gzBool isManagerRunning();

private:

    friend class gzDynamicLoader;

    virtual gzVoid process();

    gzRefList<gzRefData<gzList<gzDynamicLoader> > >     m_pendingLoaders;
    gzRefList<gzRefData<gzList<gzDynamicLoader> > >     m_spareQueues;

    gzEvent                                             m_trigger;

};

#endif

---