include/gdb/gdbNodeXyExtentEvaluationFunctor.h

Go to the documentation of this file.

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

//
// \file gdbNodeXyExtentEvaluationFunctor.h
// \brief This file contains the declaration of the DtGdbNodeXyExtentIntersectionFunctor
//

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

class DtGdbNode;


//
// This functor is used to determine if a specified DtGdbNode's extent 
// intersects another specified extent in the XY plane. If so, then it 
// evaluates to true.  Otherwise, it evaluates to false.
class DT_DLL_gdb DtGdbNodeXyExtentEvaluationFunctor : public DtGdbNodeEvaluationFunctor
{
public:
   DtGdbNodeXyExtentEvaluationFunctor(const DtExtent& extent);

   virtual ~DtGdbNodeXyExtentEvaluationFunctor();

private:
   // Copy constructor and Assignment operator not implemented
   DtGdbNodeXyExtentEvaluationFunctor(const DtGdbNodeXyExtentEvaluationFunctor& original);
   const DtGdbNodeXyExtentEvaluationFunctor& operator=(const DtGdbNodeXyExtentEvaluationFunctor& 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