include/terrainDbFactory/paperMapFactory.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: paperMapFactory.h,v $ $Revision: 1.9 $ $State: Exp $
*******************************************************************************/
#ifndef paperMapFactory_H_
#define paperMapFactory_H_

//
// \file papermapFactory.h
// \brief Contains the DtPaperMapFactory class declaration.
//

#include "terrainDbFactory/terrainDbFactoryDefines.h"
#include <vlutil/vlFilename.h>
#include <vlutil/vlList.h>
#include <map>

class DtPaperMapDatabase;
class DtPaperMap;
class DtTerrainDatabase;
class DtTdbMetafileFactory;

//
// class DtPaperMapFactory:
//
// DtPaperMapFactory has a hashlist of DtPaperMapFactoryEntry 
// indexed by the DtString type that represents the type of file able to load.
// 

class DT_DLL_terrainDbFactory DtPaperMapFactory
{
public:

   typedef DtPaperMap* (*DtPaperMapCreator)();
   typedef std::map<DtString, DtPaperMapCreator> DtPaperMapCreatorContainer;
   
   // constructor
   DtPaperMapFactory(DtTdbMetafileFactory* factory);

   // copy constructor
   DtPaperMapFactory(const DtPaperMapFactory& orig);

   // assignment operator
   const DtPaperMapFactory& operator=(
      const DtPaperMapFactory& orig);

   // Destructor: deletes factory and any entries on the factory.
   virtual ~DtPaperMapFactory();

   // Registers all the default creators with the factory.
   virtual void init();

   virtual void setMetafileFactory(DtTdbMetafileFactory* factory);
   virtual DtTdbMetafileFactory* metafileFactory();
   virtual const DtTdbMetafileFactory* metafileFactory() const;

   // Register a creator with the factory.
   virtual void registerPaperMapCreator(const DtString &type, DtPaperMapCreator fcn);

   // creator functions callers
   virtual DtPaperMap* createPaperMap(const DtString &type);


   // loading functions
   virtual bool loadPaperMap(const DtFilename& fileName, DtTerrainDatabase* terrain, 
      DtPaperMapDatabase*& paperMapDatabase, const DtList& searchPaths);

   static DtPaperMapFactory* create();

protected:

   DtPaperMapFactory();

   virtual bool loadPaperMap(const DtFilename& fileName,
      DtTerrainDatabase* terrain, DtPaperMapDatabase*& paperMapDatabase);

   DtPaperMapCreatorContainer myPaperMapCreators;
   DtTdbMetafileFactory* myTdbMetafileFactory;
};

#endif