include/terrainDbFactory/terrainReaderFactory.h

Go to the documentation of this file.

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

//
// \file terrainReaderFactory.h
// \brief Contains the DtTerrainReaderFactory class declaration and related typedefs.
//

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

class DtTerrainDatabase;
class DtTerrainReader;
class DtMetafileRecord;
class DtTdbMetafileFactory;

//
// DtTerrainReaderFactory contains a container of DtTerrainFactoryEntry creators,
// indexed by the DtString type that represents the type of file able to load.
// It is used to dynamically create the type of terrain reader that is desired.
class DT_DLL_terrainDbFactory DtTerrainReaderFactory
{
public:
   typedef DtTerrainReader* (*DtTerrainReaderCreatorFcn)();
   typedef std::map<DtString, DtTerrainReaderCreatorFcn> DtTerrainReaderCreatorContainer;


private:
   // Default constructor not available
   DtTerrainReaderFactory();

public:
   // constructor
   DtTerrainReaderFactory(DtTdbMetafileFactory *factory);

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

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

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

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

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

   // Registers a creator associated with the specified type with the factory.
   virtual void registerTerrainReaderCreator(const DtString &type, 
      DtTerrainReaderCreatorFcn fcn);

   // \return A DtTerrainReader of the specified type, OR 0 if the type is unknown.
   virtual DtTerrainReader* createTerrainReader(const DtString &type);

   static DtTerrainReaderFactory* create();

   virtual bool loadTerrain(const DtFilename& fileName, DtTerrainDatabase* terrain, 
      const DtList& searchPaths);

protected:

   virtual bool loadTerrain(const DtFilename& fileName, DtTerrainDatabase* terrain);

   DtTerrainReaderCreatorContainer myTerrainReaders;
   DtTdbMetafileFactory* myTdbMetafileFactory;
};

#endif