include/geometry/ssInsertionFunctor.h

Go to the documentation of this file.

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

#include <vlutil/vlConfig.h> 
#include "geometry/spatialSubdivision.h"
#include "geometry/ssFunctor.h"

//
// A functor intended for use with the spatial subdivision set of classes.  It's 
// primary usage is to insert the first parameter into the second.  
// 
// Expected usage:
// When passed to the intersection objects intersection functions, this fucntor 
// inserts the first item into the second one.  Used primarily for inserting the
// different spatial sorted elements into their appropriate spatial subdivisions.
// For an example, see the gdbNode inserter class.
// 
template <typename TypeToContain, typename Container>
class DtSsInsertionFunctor : public DtSsFunctor<TypeToContain, Container>
{
public:
   // Constructor
   DtSsInsertionFunctor();

   // Destructor
   virtual ~DtSsInsertionFunctor();

private:
   // not implemented
   DtSsInsertionFunctor(const DtSsInsertionFunctor& original);   
   DtSsInsertionFunctor& operator=(const DtSsInsertionFunctor& original);

public:
   // Function operator - when applied inserts the first element into the
   // second element.
   // @param itemToInsert The item to insert into the second parameter.
   // @param container The container of elements into which to insert the first
   // parameter.
   //
   // @returns Always returns false as it is never done processing - it can
   // always continue inserting elements.
   virtual bool operator()(TypeToContain& itemToInsert, Container& container);
};


//------------------------------------------------------
//  INLINE METHODS
//------------------------------------------------------
template <typename TypeToContain, typename Container>
DtSsInsertionFunctor<TypeToContain, Container>::DtSsInsertionFunctor()
: DtSsFunctor<TypeToContain, Container>()
{
}


template <typename TypeToContain, typename Container>
DtSsInsertionFunctor<TypeToContain, Container>::~DtSsInsertionFunctor()
{
}

template <typename TypeToContain, typename Container>
bool DtSsInsertionFunctor<TypeToContain, Container>::operator()(TypeToContain& itemToInsert, Container& container) 
{
   container.insert(container.end(), itemToInsert);
   return false;
}

#endif