/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file pgCullTraverser.h
 * @author drose
 * @date 2002-03-14
 */

#ifndef PGCULLTRAVERSER_H
#define PGCULLTRAVERSER_H

#include "pandabase.h"

#include "pgTop.h"
#include "cullTraverser.h"

/**
 * This is a specialization of CullTraverser for use within the pgui system.
 * It is substituted in for the normal CullTraverser by the PGTop node.  Its
 * purpose is to carry additional data through the traversal so that PGItems
 * can know how to register their regions with the current MouseWatcherGroup.
 */
class EXPCL_PANDA_PGUI PGCullTraverser : public CullTraverser {
public:
  INLINE PGCullTraverser(PGTop *top, CullTraverser *trav);

  PGTop *_top;
  int _sort_index;

public:
  static TypeHandle get_class_type() {
    return _type_handle;
  }
  static void init_type() {
    CullTraverser::init_type();
    register_type(_type_handle, "PGCullTraverser",
                  CullTraverser::get_class_type());
  }
  virtual TypeHandle get_type() const {
    return get_class_type();
  }
  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}

private:
  static TypeHandle _type_handle;
};

#include "pgCullTraverser.I"

#endif