include/geometry/intRecLst.h

Go to the documentation of this file.

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

// \file intRecLst.h
// \brief This file contains the DtChordIntersectRecordList class declaration - a wrapper for a DtList of DtChordIntersectionRecords.
#include "geometry/geometryDefines.h"
#include <list>
#include "geometry/chrdIntRec.h"

class DtChordIntersectionRecord;

typedef std::list<DtChordIntersectionRecord*> DtChordRecordList;
typedef DtChordRecordList::iterator DtChordRecordListIterator;
typedef DtChordRecordList::const_iterator DtChordRecordListConstIterator;

//
// DtChordIntersectRecordList represents a list of
// DtChordIntersectRecords. This is useful for following chord recording all
// of its intersections with a section of the terrain.
// Unlike DtList, this class "owns" all of its DtChordIntersectRecords and
// will delete them when it is destroyed.
class DT_DLL_geometry DtChordIntersectRecordList
{
public:
   // default constructor
   DtChordIntersectRecordList();

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

   // destructor
   virtual ~DtChordIntersectRecordList();

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

   // Insert a DtChordIntersectRecord in the appropriate spot. Assume list
   // is sorted in increasing distance from beginning of chord.
   virtual void insertAlongChord(const DtChordIntersectionRecord& record);

   // Merge in another DtChordIntersectRecordList; assume both lists
   // are sorted in increasing distance from beginning of chord.
   virtual void mergeAlongChord(const DtChordIntersectRecordList& otherList);

   // returns the size of our chord list.
   int count() const;

   // returns the first in the chord list.
   DtChordRecordListIterator first();

   // returns the last in the chord list.
   DtChordRecordListIterator last();

   virtual DtChordRecordList& chordList();
   virtual const DtChordRecordList& chordList() const;

protected:

   DtChordRecordList myChordRecordList;
};


#endif