contrib/meshtex/MeshVisitor.h

   1 /**
   2  * @file MeshVisitor.h
   3  * Declares the MeshVisitor class.
   4  * @ingroup meshtex-util
   5  */
   6
   7 /*
   8  * Copyright 2012 Joel Baxter
   9  *
  10  * This file is part of MeshTex.
  11  *
  12  * MeshTex is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * MeshTex is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with MeshTex.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26 #if !defined(INCLUDED_MESHVISITOR_H)
  27 #define INCLUDED_MESHVISITOR_H
  28
  29 #include "RefCounted.h"
  30 #include "MeshEntity.h"
  31
  32 #include "iselection.h"
  33
  34 /**
  35  * Visitor that will invoke Execute with a MeshEntity argument if the visited
  36  * node is a valid mesh. Subclasses should override Execute to perform
  37  * operations on the MeshEntity.
  38  *
  39  * @ingroup meshtex-util
  40  */
  41 class MeshVisitor : public SelectionSystem::Visitor, public RefCounted
  42 {
  43 public: // public methods
  44
  45    MeshVisitor();
  46    virtual ~MeshVisitor();
  47    void ResetVisitedCount();
  48    unsigned GetVisitedCount();
  49    void visit(scene::Instance& instance) const;
  50
  51 protected: // protected methods
  52
  53    virtual bool Execute(MeshEntity& meshEntity) const;
  54
  55 private: // private static member vars
  56
  57    /// @name Callbacks to use when constructing the MeshEntity
  58    //@{
  59    static const MeshEntity::MessageCallback _infoReportCallback;
  60    static const MeshEntity::MessageCallback _warningReportCallback;
  61    static const MeshEntity::MessageCallback _errorReportCallback;
  62    //@}
  63
  64 private: // private member vars
  65
  66    /**
  67     * Track the number of Execute invocations.
  68     */
  69    mutable unsigned _visitedCount;
  70 };
  71
  72 #endif // #if !defined(INCLUDED_MESHVISITOR_H)