include/gdb/pointIM.h

Go to the documentation of this file.

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

#include "gdb/gdbDefines.h"
#include "geometry/point.h"
#include "gdb/indexedMarked.h"

//
// A DtPointIndexedMarked associates a specified DtPoint with an IndexedMarked
// This is used by the DtVectorNetwork to remove duplicate vertices.
// @see DtVectorNetwork
//
// @note This class has no virtual functions on purpose to reduce the size.  
// Because an instance is created for every vertex during vertex reduction, the size
// difference becomes important for large scenes.  Additionally, classes should
// @b not be derived from this class.
//
class DT_DLL_gdb DtPointIndexedMarked
{
public:

   // default constructor
   DtPointIndexedMarked();

   // destructor
   ~DtPointIndexedMarked();

   // constructor from a parent
   DtPointIndexedMarked(DtPoint& orig);

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

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

   // This function replaces the sortWorldCoordinatePointsByX
   // @returns true if the specified other DtPointIndexedMarked
   // is larger.  
   // DtPointIndexedMarked point1 is < DtPointIndexedMarked point2 
   // iff its X, Y, and Z components are each < their corresponding component 
   // in point2.  The order is important.  If x1 < x2, then point1 < point2, 
   // even if y1 > y2 or z1 > z2.  
   // @note Essentially sorts in x direction, then y and then z only if the 
   // previous components are equal.  
   bool operator<(const DtPointIndexedMarked& other) const;

   DtPoint* point();
   const DtPoint* point() const;

   // access to the indexer
   DtIndexedMarked* indexer();

protected:

   DtIndexedMarked myIndexer;
   DtPoint* myPoint;
};


#endif