include/gdb/basicTerrainIntersector.h

Go to the documentation of this file.

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


#ifndef basicTerrainIntersector_h
#define basicTerrainIntersector_h

#include "gdb/terrainIntersector.h"
#include "gdb/terrainIntersectorDescriptor.h"

class DtBasicTerrainIntersectorDescriptor;

// An intersector for DtTerrainDatabase class.
// This intersector doesn't use any special intersection optimization, and
// does not allocate any additional memory.  It is useful when reduced memory
// footprint is more important than intersection speed.
class DT_DLL_gdb DtBasicTerrainIntersector : public DtTerrainIntersector
{
private:
   // Not implemented.
   DtBasicTerrainIntersector();
   // Not implemented.
   DtBasicTerrainIntersector(const DtBasicTerrainIntersector& orig);
   // Not implemented.
   DtBasicTerrainIntersector& operator=(const DtBasicTerrainIntersector& orig);

public:
   DtBasicTerrainIntersector(DtTerrainDatabase* terrainDb,
      const DtTerrainIntersectorDescriptor* descriptor);
   virtual ~DtBasicTerrainIntersector();

   virtual bool init();
   virtual bool reinitialize();

   // \return The total number of bytes of memory used by this intersector
   // and any of its internal indexing into the terrain.
   virtual unsigned int memoryUsage() const;

   virtual bool chordIntersect(const DtChord& chord,
      DtChordIntersectionRecord& record,
      DtGdbNode::DtIntersectRecordType irtFlag = DtGdbNode::IRT_ALL_DATA_TERRAIN) const;

   virtual bool allIntersectsAlongChord(const DtChord& chord,
      DtChordIntersectRecordList& intList,
      DtGdbNode::DtIntersectRecordType irtFlag = DtGdbNode::IRT_ALL_DATA_TERRAIN) const;

   virtual bool sphereIntersect(const DtSphere& sphere, DtSphereIntersectionRecord& record,
      DtGdbNode::DtIntersectRecordType irtFlag = DtGdbNode::IRT_ALL_DATA_TERRAIN) const;

   virtual int terrainIntersectorType() const;

   virtual bool load(FILE*) { return true; };
   virtual bool save(FILE*) { return true; };

   // \return A descriptor for setting this intersector to the DtTerrainDatabase.
   static DtBasicTerrainIntersectorDescriptor* createDescriptor();
};

// Descriptor for the DtBasicTerrainIntersector class.
class DT_DLL_gdb DtBasicTerrainIntersectorDescriptor : public DtTerrainIntersectorDescriptor
{
public:
   DtBasicTerrainIntersectorDescriptor();
   DtBasicTerrainIntersectorDescriptor(const DtBasicTerrainIntersectorDescriptor& orig);
   virtual ~DtBasicTerrainIntersectorDescriptor();

   DtBasicTerrainIntersectorDescriptor& operator=(const DtBasicTerrainIntersectorDescriptor& orig);

   virtual int terrainIntersectorType() const;

   virtual DtTerrainIntersectorDescriptor* clone() const;

   virtual void descriptorInformation(DtString& name, DtString& properties) const;
};

#endif