include/gdb/gdbChordIntersectionRecord.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: gdbChordIntersectionRecord.h,v $ $Revision: 1.1 $ $State: Exp $
** Created: 2/2/10 MEM
*********************************************************************/
#ifndef gdbChordIntersectionRecord_H_
#define gdbChordIntersectionRecord_H_

// \file chrdIntRec.h
// \brief Contains the DtGdbChordIntersectionRecord class declaration.
#include "gdb/gdbDefines.h"
#include "geometry/chrdIntRec.h"
#include "geometry/point.h"
#include "geometry/surface.h"
#include <matrix/vlVector.h>

class DtAllTypesPolygon;

// Instances of DtGdbChordIntersectionRecord are used to record the 
// results of chord/primitive intersection attempts.
class DT_DLL_gdb DtGdbChordIntersectionRecord : public DtChordIntersectionRecord
{
public:

   // default constructor
   DtGdbChordIntersectionRecord();

   DtGdbChordIntersectionRecord(DtPoint& intersectionPoint, 
                             double intersectionTime,
                             DtVector& normal, 
                             DtSurface* surface, 
                             DtAllTypesPolygon* polygon, 
                             bool ownPolygon);

   // destructor
   virtual ~DtGdbChordIntersectionRecord();

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

   // assignment operator
   // Note: if "orig" owns its own polygon, this will make a copy of the
   // polygon so that this object can own it's own copy.
   DtGdbChordIntersectionRecord& operator=(const DtGdbChordIntersectionRecord& orig);

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

   //debugging aid
   virtual void dump() const;

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

   // Get a pointer to the intersecting polygon.
   DtAllTypesPolygon* polygon();
   const DtAllTypesPolygon* polygon() const;

   // \return A boolean indication whether or not the intersection record
   // owns the polygon it points to or not.  If not, then the polygon is not
   // destroyed when the record is.  If it is, then the polygon should only 
   // be referenced while the record is still valid.
   bool ownPolygon() const;

   // Set the intersecting polygon.
   // Makes it's own copy of the given polygon
   void setPolygon(const DtAllTypesPolygon& arg);

   // Shares a pointer to someone else's polygon (it better outlast us)
   void sharePolygon(DtAllTypesPolygon* arg);

   // Takes over ownership of the given polygon
   void takePolygon(DtAllTypesPolygon* arg);

   // Like operator= except that it transfers ownership of the polygon to
   // another DtGdbChordIntersectionRecord instead of potentially copying it.
   virtual void copyAndStealPolygonFrom(DtGdbChordIntersectionRecord& donor);

protected:

   // Make a copy of a polygon
   static DtAllTypesPolygon* copyPolygon(const DtAllTypesPolygon& orig);

   // Most primitive polygon to get hit. 
   DtAllTypesPolygon*   myPolygon; 
   bool                 myOwnPolygon;
};

inline DtAllTypesPolygon* DtGdbChordIntersectionRecord::polygon()
{
   return myPolygon;
}
inline const DtAllTypesPolygon* DtGdbChordIntersectionRecord::polygon() const
{
   return myPolygon;
}

inline bool DtGdbChordIntersectionRecord::ownPolygon() const
{
   return myOwnPolygon;
}

#endif