include/terrainDbFactory/additionalDataRecord.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2006 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: additionalDataRecord.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/


#ifndef additionalDataRecord_h
#define additionalDataRecord_h

#include "terrainDbFactory/mfRec.h"
#include "terrainDbFactory/terrainDbFactoryDefines.h"

// This is a terrain metafile record that specifies some type of additional
// data.  Subclasses of this type can hold any additional data necessary.
// This class contains an includeInMtd function that must be implemented by
// the subclasses.
class DT_DLL_terrainDbFactory DtAdditionalDataRecord : public DtMetafileRecord
{

public:

   DtAdditionalDataRecord();

   virtual ~DtAdditionalDataRecord();

   DtAdditionalDataRecord(const DtAdditionalDataRecord& orig);

   DtAdditionalDataRecord& operator=(const DtAdditionalDataRecord& orig);

   // The return value of this method determines whether this record will
   // be included in the .mtd file created by the TDB Tool.  
   // Typically this will be true when this data is an output of the TDB
   // tool and necessary to be read in with the generated terrain into the 
   // simulation applications.  False when this is treated as an input
   // to generating a terrain.
   virtual bool includeInMtd() const = 0;

   // \return DtConfigAdditionalDataType
   virtual DtConfigCategoryType recordCategory() const;
};

#endif