include/gdb/ssGdbNodeInserter.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: ssGdbNodeInserter.h,v $ $Revision: 1.6 $ $State: Exp $
******************************************************************************/
#ifndef ssGdbNodeInserter_H_
#define ssGdbNodeInserter_H_

#include "gdb/gdbDefines.h"
#include "geometry/spatialSubdivision.h"

class DtGdbNode;

// The DtSsGdbNodeInserter class is responsible for properly inserting
// a DtGdbNode into a DtSpatialSubdivision.
// 
class DT_DLL_gdb DtSsGdbNodeInserter
{
public:
   DtSsGdbNodeInserter();

   virtual ~DtSsGdbNodeInserter();
   
private:
   // not implemented
   DtSsGdbNodeInserter(const DtSsGdbNodeInserter& original);
   DtSsGdbNodeInserter& operator=(const DtSsGdbNodeInserter& original);

public:
   // Function to insert a DtGdbNode into a spatial subdivision.  If the insertion
   // is successful, pointers to the specified DtGdbNode will be contained by all
   // cells in the spatial subdivision that intersect the node.
   //
   // @returns A boolean indicating whether or not the node was inserted into the
   // spatial subdivision.
   virtual bool insert(DtGdbNode* terrain, DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision);
};

#endif