include/geometry/ssSphereIntersector.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: ssSphereIntersector.h,v $ $Revision: 1.2 $ $State: Exp $
******************************************************************************/
#ifndef ssShpereIntersector_H_
#define ssSphereIntersector_H_

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

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

#include "geometry/sphere.h"
#include "geometry/point.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 DtSsSphereIntersector is *solely* responsible for intersecting a DtSphere and a 
// DtSpatialSubdivision together.  It does not know what to do with the intersection
// results, 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 DtSsSphereIntersector
{
public:

   // Constructor
   DtSsSphereIntersector();

   // Destructor
   virtual ~DtSsSphereIntersector();

   // Intersects the specified chord and spatial subdivision together.
   // @returns A boolean indicating whether or not the chord intersected the
   // spatial subdivision at all.  
   // @note Technically, this returns true if the chord's @b extent intersects 
   // the spatial subdivision at all.  It does not do a true mathematical 
   // intersection of the chord and the SS.
   virtual bool intersect(const DtSphere& sphere, DtSpatialSubdivision< T >& spatialSubdivision) const;

   // Intersects the specified chord 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 chord intersected the
   // spatial subdivision or not. Has nothing to do with the functor's success
   // or failure in its own processing.
   // 
   // @note Unlike the above intersection function, this function only returns 
   // true if the chord intersected the SS, not just the chord's extent.  And the
   // functor is applied to the cells in the SS in the order that the chord intersects
   // them.
   //
   virtual bool intersect(const DtSphere& sphere, 
      DtSpatialSubdivision< T >& spatialSubdivision,
      DtSsFunctor<const DtSphere, DtSPATIAL_SUB_CELL_TYPE >& functor) const;

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

};

#define SSSPHEREINTERSECTOR_HEADER
#include "geometry/ssSphereIntersector.inl"
#undef SSSPHEREINTERSECTOR_HEADER

#ifdef DtSPATIAL_SUB_CELL_TYPE
#undef DtSPATIAL_SUB_CELL_TYPE
#endif

#endif