include/gdb/refGroup.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2001 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: refGroup.h,v $ $Revision: 1.8 $ $State: Exp $
*********************************************************************/

#ifndef refGroup_H_
#define refGroup_H_

#include "gdb/gdbDefines.h"
#include "gdb/group.h"

// class DtRefGroup:
//
// Instances of DtRefGroup are just DtGroups that only own children that are
// DtRefGroups.  Any other children are just references to nodes owned by
// other DtGroups.
//
class DT_DLL_gdb DtRefGroup : public DtGroup
{
public:

   // default constructor
   DtRefGroup();

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

   // destructor
   virtual ~DtRefGroup();

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

   // returns the type of gdb node
   virtual DtGdbNodeType type() const;

   // Return the minimum terrain file version number that this Node can be
   // saved in.
   virtual DtTerrainFileVersionNumber minSaveVersion() const;

   // Finds and removes all instances of node type searchType in the tree
   // below this node.  This call does not delete the nodes unless they happen
   // to be other DtRefGroups.  It also only recurses down into other
   // DtRefGroups.
   virtual void purgeAllInstancesOf(const DtGdbNodeType searchType);

   // Finds and removes all instances of every DtRefGroup node type in the
   // tree below this node; deletes them if they are not memory managed.  It
   // returns this.
   virtual DtGdbNode* purgeAll();

   //
   // THE FOLLOWING FUNCTIONS ARE CURRENTLY UNIMPLEMENTED AND ARE HERE JUST TO
   // PREVENT THE BASE CLASS ONES FROMN BEING CALLED.
   //

   // Reconstitute the group after each child is reduced, eliminating 
   // child nodes that reduce to null.
   virtual void reduceChildren(int& numReductions);

   // reduce the group object to eliminate redundant nodes.
   virtual DtGdbNode* reduce(int& numReductions);

   //Finds and replaces all three-sided polygons with triangles
   //in the tree below this node.  
   void polygonToTriangle(DtMemoryManager* memMgr,
                          unsigned int& numIndConverted, 
                          unsigned int& numIndTotal); 


   //This method returns a balanced-tree.  branching is the maximum
   //branching factor, and bushiness is the number of leaves in the last
   //group.  This function leaves the old tree intact.
   virtual DtGroup* balanced(unsigned int branching, unsigned int bushiness);

   //This method returns a balanced-tree.  branching is the maximum
   //branching factor, and bushiness is the number of leaves in the last
   //group.  This function purges the groups in the old tree.
   virtual DtGroup* balancedAndPurged(unsigned int branching, unsigned int bushiness); 

   virtual int sizeInBytes() const;

protected:

};

#endif