include/geometry/intersectionRecord.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2006 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: intersectionRecord.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/
#ifndef intersectionRecord_H_
#define intersectionRecord_H_

// \file intersectionRecord.h
// \brief DtIntersectionRecord.  
#include "geometry/geometryDefines.h"

// \brief Base class for all terrain intersection records.
class DT_DLL_geometry DtIntersectionRecord
{
public: 

   // The type of intersection record.
   enum DtRecordType
   {
      // base class, simple true or false if there's an intersection
      BASE_TYPE = 0, 
      // uses a chord for the intersection check, can return intersection points, normals, surfaces
      // not terrain implementation assumed
      CHORD_TYPE = 1, 
      // uses a chord for the intersection check, can return intersection points, normals, surfaces
      // Gdb terrain implementation assumed and therefore can also return intersection polygons
      GDBCHORD_TYPE = 2, 
      // uses a sphere for the intersection check, can return intersection points, normals, surfaces
      // not terrain implementation assumed
      SPHERE_TYPE = 3,
      // uses a sphere for the intersection check, can return intersection points, normals, surfaces
      // Gdb terrain implementation assumed and therefore can also return intersection polygons
      GDBSPHERE_TYPE = 4
   };

   // The Intersection Type flag indicates the kind of data requested from
   // a call to one of the intersect functions. Bit operators can be used on these enumerations.
   enum DtIntersectionType
   {
      // INT_EXISTS returns only a bool indication that an intersection was
      // found.
      INT_EXISTS = 0,

      // INT_POINT is like INT_EXISTS, but also returns the closest intersection
      // point as a DtPoint, the associated "time" value, and the
      // surface type.
      INT_POINT = 0x01,

      // INT_NORMAL is like INT_EXISTS, but also returns the normal as a
      // DtWorldCoordVector.
      INT_NORMAL = 0x02,

      // INT_RESERVED is currently reserved for an internal intersection call.
      INT_RESERVED = 0x04,

      // INT_ALL_DATA requests that all possible data be returned from the terrain node
      INT_ALL_DATA = 0x07
   };

   DtIntersectionRecord();
   virtual ~DtIntersectionRecord();

   // copy constructor
   DtIntersectionRecord(const DtIntersectionRecord& orig);

   // assignment operator
   DtIntersectionRecord& operator=(const DtIntersectionRecord& orig);

   // clone this object
   virtual DtIntersectionRecord* clone() const;

   // The type of record used for the intersection query. Returns
   // BASE_TYPE
   virtual DtRecordType type() const;

   // debugging aid
   virtual void dump() const;

   bool intersectionFound() const;
   void setIntersectionFound(bool arg);

protected:
   bool myIntersectionFound;

};

inline bool DtIntersectionRecord::intersectionFound() const
{
   return myIntersectionFound;
}

inline void DtIntersectionRecord::setIntersectionFound(bool arg)
{
   myIntersectionFound = arg;
}
#endif