ssExtentIntersector.h

Go to the documentation of this file.

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

#include <vlutil/vlConfig.h> 
#include <vlutil/vlPrint.h>

#include "geometry/spatialSubdivision.h"
#include "geometry/ssFunctor.h"

#include "geometry/chord.h"
#include "geometry/point.h"
#include "geometry/plane.h"
#include "geometry/extent.h"

// Note:  Must use this macro to get around issues with VC 6.0 vs .Net/gcc.
// 6.0 complains if you use the typename qualifier outside of a class definition,
// but it is incorrect to not specify that the cell type is a type when using it
// as a template parameter.
#ifdef DtSPATIAL_SUB_CELL_TYPE
#undef DtSPATIAL_SUB_CELL_TYPE
#endif

#if _MSC_VER == 1200 // Visual Studio 6.0
#define DtSPATIAL_SUB_CELL_TYPE DtSpatialSubdivision< T >::DtSpatialSubCellType 
#else
#define DtSPATIAL_SUB_CELL_TYPE typename DtSpatialSubdivision< T >::DtSpatialSubCellType 
#endif



//
// The DtSsExtentIntersector is *solely* responsible for intersecting a DtExtent and a 
// DtSpatialSubdivision together.  
// It does not know what to do with the intersection results, other than apply the
// functor, nor does it rely on the specific contents of the spatial subdivision.
//
// This is one of the basic SS intersection classes provided by the toolkit.
//
template <typename T>
class DtSsExtentIntersector
{
public:

   // Constructor
   DtSsExtentIntersector();

   // Destructor
   virtual ~DtSsExtentIntersector();

   // Intersects the specified extent and spatial subdivision together.
   // @returns A boolean indicating whether or not the extent intersected the
   // spatial subdivision at all.  
   virtual bool intersect(const DtExtent& extent, DtSpatialSubdivision< T >& spatialSubdivision) const;

   // Intersects the specified extent and spatial subdivision together.  Applies
   // the functor to the intersection results, in order, until the functor 
   // is done processing (returns true).
   // 
   // @returns A boolean indicating whether or not the extent intersected the
   // spatial subdivision or not.  Has nothing to do with the functor's success
   // or failure in its own processing.
   // 
   virtual bool intersect(const DtExtent& extent, 
      DtSpatialSubdivision< T >& spatialSubdivision,
      DtSsFunctor<const DtExtent, DtSPATIAL_SUB_CELL_TYPE >& functor) const;

   // This is provided to account for functors that take the template parameter 
   // to the spatial subdivision as the first parameter (such as insertion functors)
   // rather than the intersection primitive, such as intersection functors
   //
   // @note All objects to intersect passed to this function @b must support the
   // expandExtent() function, so the intersector can determine the extent to use
   // for performing the intersection.
   virtual bool intersect(T& objectToIntersect,
      DtSpatialSubdivision< T >& spatialSubdivision,
      DtSsFunctor<T, DtSPATIAL_SUB_CELL_TYPE >& functor) const;

   // Provides the minimum and maximum indices (X,Y,Z) of the cells comprising 
   // the intersection of the extent and the spatial subdivision.
   // 
   // @returns a boolean indicating whether or not there is an intersection.
   // @note  If there is no intersection, the index values are undetermined.
   virtual bool getIndices(const DtExtent& extent,
      const DtSpatialSubdivision< T >& spatialSubdivision, int& minXIndex, 
      int& minYIndex, int& minZIndex, int& maxXIndex, int& maxYIndex, int& maxZIndex) const;

private:
   // Copy constructor & Assignment operator  - not implemented
   DtSsExtentIntersector(const DtSsExtentIntersector& orig);
   DtSsExtentIntersector& operator=(const DtSsExtentIntersector& orig);

private:

};

// Include the inline code
#define SSEXTENTINTERSECTOR_HEADER
#include "geometry/ssExtentIntersector.inl"
#undef SSEXTENTINTERSECTOR_HEADER

#ifdef DtSPATIAL_SUB_CELL_TYPE
#undef DtSPATIAL_SUB_CELL_TYPE
#endif

#endif