include/gdb/ssTerrainIntersector.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: ssTerrainIntersector.h,v $ $Revision: 1.1 $ $State: Exp $
*********************************************************************/
#ifndef ssTerrainIntersector_H_
#define ssTerrainIntersector_H_

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

class DtChord;
class DtChordIntersectionRecord;
class DtPoint;

// class DtSSTerrainIntersector:
//
// The DtSSTerrainIntersector class is intersects the spatial subdivision that 
// contains DtGdbNode pointers (the terrain), with the specified primitive - 
// chord or otherwise, and provides the appropriate intersection values as a 
// result, if an intersection occurred.
// 
class DT_DLL_gdb DtSSTerrainIntersector
{
public:
   DtSSTerrainIntersector() {};

   virtual ~DtSSTerrainIntersector() {};

   // Intersects the chord with the spatial subdivision and returns the point 
   // and time along the chord of the first intersection.
   //
   // @param chord The chord to intersect
   // @param spatialSubdivision The spatialSubdivision to intersect.
   // @param intersectionPoint The location of the intersection if any.
   // @param intersectionTime The time along the chord of the intersection, if any
   // 
   // @returns a boolean indicating success or failure to find any intersections.
   //
   // @note If no intersection occurs, the intersectionPoint and Time values are 
   // not defined.
   //
   bool intersect(const DtChord& chord, 
                  DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision, 
                  DtPoint& intersectionPoint, 
                  double& intersectionTime) const;

   // Intersects the chord with the spatial subdivision and returns the point 
   // and time along the chord of the first intersection.
   //
   // @param chord The chord to intersect
   // @param spatialSubdivision The spatialSubdivision to intersect.
   // @param record The intersection record contained all intersection data 
   //               specified by the intersection flag.
   // @param irtFlag Flag specifying what intersection data to record in the record.
   // 
   // @returns a boolean indicating success or failure to find any intersections.
   //
   // @note If no intersection occurs, the intersectionPoint and Time values are 
   // not defined.
   //
   bool intersect(const DtChord& chord, 
                  DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision, 
                  DtChordIntersectionRecord& record, 
                  DtGdbNode::DtIntersectRecordType irtFlag) const;

   bool allIntersectsAlongChord(const DtChord& chord,
                                DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision,
                                DtChordIntersectRecordList& intList,
                                DtGdbNode::DtIntersectRecordType irtFlag) const;

   int intersectBundle(const DtChordBundle& chordBundle,
                       DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision, 
                       DtList& recordList, 
                       DtGdbNode::DtIntersectRecordType irtFlag) const;

   int allIntersectsAlongChordBundle(const DtChordBundle& chordBundle,
                                     DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision,
                                     DtList& intListList, 
                                     DtGdbNode::DtIntersectRecordType irtFlag) const;

   // \return True if the specified sphere intersects the terrain.
   bool intersect(const DtSphere& sphere,
      DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision, 
      DtSphereIntersectionRecord& record, 
      DtGdbNode::DtIntersectRecordType irtFlag) const;

   // \return True if the specified swept sphere volume intersects the terrain.
//   bool intersect(const DtSweptSphere& sweptSphere, 
//      DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision, 
//      DtIntersectionRecord& record, 
//      DtGdbNode::DtIntersectRecordType irtFlag) const;

protected:
   // not implemented
   DtSSTerrainIntersector(const DtSSTerrainIntersector& original);
   DtSSTerrainIntersector& operator=(const DtSSTerrainIntersector& original);

   // Check to see if the intersection point is in the same cell as the specified
   // spatial subdivision cell.
   bool intersectionInSameCell(const DtPoint& intersectionPoint, 
                               const DtSpatialSubdivision<DtGdbNode*>::DtSpatialSubCellType* spatialSubCell,
                               const DtSpatialSubdivision<DtGdbNode*>& spatialSubdivision) const;

private:
};

#endif