include/gdb/opcodeTerrainIntersector.h

Go to the documentation of this file.

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


#ifndef opcodeTerrainIntersector_h
#define opcodeTerrainIntersector_h

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

class DtOpcodeTerrainIntersectorDescriptor;
class DtOpcodeTerrainIntersectorImpl;

// Terrain intersector that uses the external OPCODE library do do terrain
// intersection.  This takes a little while to init(), and uses a decent
// amount of memory, but results in very fast runtime intersection checks.
class DT_DLL_gdb DtOpcodeTerrainIntersector : public DtTerrainIntersector
{
private:
   // Not implemented.
   DtOpcodeTerrainIntersector();
   // Not implemented.
   DtOpcodeTerrainIntersector(const DtOpcodeTerrainIntersector& orig);
   // Not implemented.
   DtOpcodeTerrainIntersector& operator=(const DtOpcodeTerrainIntersector& orig);

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

   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;

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

   // \return True if the OPCODE Intersector is valid to use on this terrain
   // database.  Tests to see if each vertex in the database can be converted
   // to floating point without loosing too much precision.
   static bool intersectorValid(const DtTerrainDatabase* terrainDb);

protected:
   DtOpcodeTerrainIntersectorImpl* myImpl;
};

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

   DtOpcodeTerrainIntersectorDescriptor& operator=(const DtOpcodeTerrainIntersectorDescriptor& orig);

   virtual int terrainIntersectorType() const;

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

   virtual DtTerrainIntersectorDescriptor* clone() const;
};

#endif