include/vrfobjcore/vrfObjectIntersectionRecord.h

Go to the documentation of this file.

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



#include "geometry/point.h"
#include "geometry/surface.h"
#include <assert.h>

class DtVrfObject;

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtVrfObjectIntersectionRecord
{
public:
   DtVrfObjectIntersectionRecord();

   DtVrfObjectIntersectionRecord(DtPoint& intersectionPoint, 
      double intersectionTime, const DtSurface& surface, DtVrfObject* intersectedObject);

   virtual ~DtVrfObjectIntersectionRecord();


   //accessor/mutator functions
   bool intersectionFound() const;
   void setIntersectionFound(bool arg);

   //set/get intersectionPoint
   const DtPoint intersectionPoint() const;
   void setIntersectionPoint(const DtPoint& pt);

   //set/get intersectionTime
   const double intersectionTime() const;
   void setIntersectionTime(double t);

   //set/get intersecting surface
   const DtSurface surface() const;
   void setSurface(const DtSurface& s);

   DtVrfObject* intersectedVrfObject();
   const DtVrfObject* intersectedVrfObject() const;
   void setIntersectedVrfObject(DtVrfObject* vrfObj);

   inline unsigned int numberOfIntersectionTests() const;
   inline void incrementNumberOfIntersectionTests();
   inline void setNumberOfIntersectionTests(unsigned int newNumberOfTests);

protected:
   bool testInvariant() const;

private:

   bool           myIntersectionFound;
   DtPoint        myIntersectionPoint;
   double         myIntersectionTime;
   DtSurface      mySurface;

   DtVrfObject*   myIntersectedVrfObject; 

   unsigned int   myNumberOfIntersectionTests;
};


inline bool DtVrfObjectIntersectionRecord::intersectionFound() const
{
   assert(testInvariant());
   return myIntersectionFound;
}

inline void DtVrfObjectIntersectionRecord::setIntersectionFound(bool yesOrNo)
{
   assert(testInvariant());
   myIntersectionFound = yesOrNo;
   assert(testInvariant());
}

inline const DtPoint DtVrfObjectIntersectionRecord::intersectionPoint() const
{
   assert(testInvariant());
   return myIntersectionPoint;
}

inline void DtVrfObjectIntersectionRecord::setIntersectionPoint(
   const DtPoint& newPoint)
{
   assert(testInvariant());
   myIntersectionPoint = newPoint;
   assert(testInvariant());
}

inline const double DtVrfObjectIntersectionRecord::intersectionTime() const
{
   assert(testInvariant());
   return myIntersectionTime;
}

inline void DtVrfObjectIntersectionRecord::setIntersectionTime(double newTime)
{
   assert(testInvariant());
   myIntersectionTime = newTime;
   assert(testInvariant());
}

inline const DtSurface DtVrfObjectIntersectionRecord::surface() const
{
   assert(testInvariant());
   return mySurface;
}

inline void DtVrfObjectIntersectionRecord::setSurface(const DtSurface& newSurface)
{
   assert(testInvariant());
   mySurface = newSurface;
   assert(testInvariant());
}

inline DtVrfObject* DtVrfObjectIntersectionRecord::intersectedVrfObject()
{
   assert(testInvariant());
   return myIntersectedVrfObject;
}
inline const DtVrfObject* DtVrfObjectIntersectionRecord::intersectedVrfObject() const
{
   assert(testInvariant());
   return myIntersectedVrfObject;
}

inline void DtVrfObjectIntersectionRecord::setIntersectedVrfObject(DtVrfObject* vrfObject)
{
   assert(testInvariant());
   myIntersectedVrfObject = vrfObject;
   assert(testInvariant());
}

inline unsigned int DtVrfObjectIntersectionRecord::numberOfIntersectionTests() const
{
   assert(testInvariant());
   return myNumberOfIntersectionTests;
}

inline void DtVrfObjectIntersectionRecord::incrementNumberOfIntersectionTests()
{
   assert(testInvariant());
   ++myNumberOfIntersectionTests;
   assert(testInvariant());
}

inline void DtVrfObjectIntersectionRecord::setNumberOfIntersectionTests(unsigned int newNumberOfTests)
{
   assert(testInvariant());
   myNumberOfIntersectionTests = newNumberOfTests;
   assert(testInvariant());
}

#endif