gdbNodeExtentSelectionFunctor.h

Go to the documentation of this file.

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

//
// \file gdbNodeExtentEvaluationFunctor.h
// \brief Contains the DtGdbNodeExtentSelectionFunctor class desclaration and related functionality.
//

#include "gdb/gdbDefines.h"
#include "gdb/gdbNodeEvaluationFunctor.h"
#include <geometry/extent.h>

class DtGdbNode;


//
// This functor determines if a specified DtGdbNode's extent intersects a 
// specified extent.  If so, then it evaluates to true.  Otherwise, it evaluates
// to false.
class DT_DLL_gdb DtGdbNodeExtentSelectionFunctor : public DtGdbNodeEvaluationFunctor
{
public:
   DtGdbNodeExtentSelectionFunctor(const DtExtent& extent);

   virtual ~DtGdbNodeExtentSelectionFunctor();

private:
   // Copy constructor and Assignment operator not implemented
   DtGdbNodeExtentSelectionFunctor(const DtGdbNodeExtentSelectionFunctor& original);
   const DtGdbNodeExtentSelectionFunctor& operator=(const DtGdbNodeExtentSelectionFunctor& original);
   
public:

   // \return True if the specified node's extent intersects this functor's 
   // extent and false otherwise.  
   // \note This does \b not do an exact intersection test between this functor's
   // extent and the specified node's actual dimensions, whatever they may be.
   // It tests the extent \b only.
   bool operator()(const DtGdbNode& nodeToEvalulate);


protected:

private:

   DtExtent myExtent;
};

#endif