include/gdb/terrainIntersectorDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: terrainIntersectorDescriptor.h,v $ $Revision: 1.3 $ $State: Exp $
*******************************************************************************/


#ifndef terrainIntersectorDescriptor_h
#define terrainIntersectorDescriptor_h

#include "gdb/gdbDefines.h"

class DtString;

// Base class for all descriptors of DtTerrainIntersector classes.
// The descriptors contain the type and any parameters for the intersector.
// Subclasses must by copyable.
class DT_DLL_gdb DtTerrainIntersectorDescriptor
{
public:
   DtTerrainIntersectorDescriptor() {};
   DtTerrainIntersectorDescriptor(const DtTerrainIntersectorDescriptor& orig) {};
   virtual ~DtTerrainIntersectorDescriptor() {};

   DtTerrainIntersectorDescriptor& operator=(const DtTerrainIntersectorDescriptor& orig) {return *this;};

   // \return The type identifier for the DtTerrainIntersector that this
   // descriptor is for.  The descriptors and the intersectors use the 
   // same type identifiers.
   virtual int terrainIntersectorType() const = 0;

   // \return A copy of the descriptor.
   virtual DtTerrainIntersectorDescriptor* clone() const = 0;

   // Called to return information about this descriptor
   virtual void descriptorInformation(DtString& name, DtString& properties) const = 0;

};

#endif