surfaceCharacteristicMap.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1998 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: surfCharMap.h,v $ $Revision: 1.13 $ $State: Exp $
*******************************************************************************/

#ifndef surfaceCharacteristicMap_H_
#define surfaceCharacteristicMap_H_

#include "flt/fltDefines.h"
#include "geometry/surface.h"
#include <vlutil/vlConfig.h>
#include <vlutil/vlUtil.h>
#include <vlutil/vlFilename.h>
#include <vlutil/vlString.h>
#include <iosfwd>
#include <set>
#include <map>
#include <string>

class DtSurface;

//
// This is the base class for all metafile records.
class DT_DLL_flt DtSurfaceCharacteristicMap 
{

public:

   // default constructor.
   DtSurfaceCharacteristicMap();

   // destructor
   virtual ~DtSurfaceCharacteristicMap();

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

   // assignment operator - provided by default by compiler. 
   // This class is assignable.

   // Initialize the metafile.  Calls createSurface().
   virtual bool init(const DtFilename filename, bool displayWarning = false);

   // get data from a stream
   virtual bool get(std::istream& stream);

   // identifies a token or passes token the parent class.
   virtual bool processToken(std::istream& stream, DtString& token);

   // Set characteristics based on a string 
   virtual bool characteristicsFromString(const char* str, 
      unsigned int& characteristics);

protected:

   // Creates mySufarce.
   virtual DtSurface* createSurface();

protected:
   typedef std::map <DtString, DtSurface::DtCharacteristics> DtSurfaceStringToCharacteristics;
   typedef DtSurfaceStringToCharacteristics::const_iterator DtSurfStrToCharsConstIter;
   typedef DtSurfaceStringToCharacteristics::iterator DtSurfStrToCharsIter;

   DtSurfaceStringToCharacteristics mySurfaceStringToCharacteristics;
   static const DtString theMatchString;
   DtSurface* mySurface;

private:

   // This is here to prevent error messages from streaming out when many polygons
   // have textures not referenced in the surface characteristics map.  Should
   // probably be changed to a logging class that is a member of the class, that explicitly
   // has the "only output once" logic held internally.
   // NOTE: This is used in the characteristicsFromString function.
   // @see characteristicsFromString
   std::set<std::string> myPrintedWarnings;

};

#endif