ModelIterator.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Design
File: ModelIterator
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Model.h>
#include <NDEVR/Geometry.h>
#include <functional>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A base class for easily transversing a model heirarchy, applying an overritten function 
        at each level or for each object.
    **/
    class NDEVR_DESIGN_API ModelIterator
    {
    public:
        enum ParseResult
        {
              e_continue_parsing
            , e_do_not_parse_children
            , e_finish_parsing
        };
        ModelIterator();
        explicit ModelIterator(const Model& model);
        explicit ModelIterator(Buffer<Model> models);
        void parseAll(const Model& model);
        void parseAll(const Buffer<Model>& models);
        void parseAll();
        ParseResult parseNext();
        Model currentModel() const;
        std::function<bool(const Model&, const Geometry&)> geo_filter;
        std::function<bool(const Model&, const Material&)> material_filter;
        std::function<bool(const Model&)> model_filter;
        
        bool process_material = false;
        bool process_geometry = true;
        bool process_model = true;
        bool post_process_model = false;
        bool depth_first = true;
        bool is_recursive = true;
        bool use_unit = false;
        PrimitiveProperty material_property = PrimitiveProperty::Solid;
    protected:
        virtual ParseResult process(Model& model);
        virtual ParseResult process(Model& model, Material& mat);
        virtual ParseResult process(Model& model, Geometry& geo);
        virtual ParseResult postProcess(Model& model);
        void removeFromPostProcessStack();
        virtual void parseAllModels();
        Model popNextModel();
        Buffer<Model> m_model_stack;
        Buffer<uint04> m_model_parent_child_count;
        Buffer<Model> m_model_parent_stack;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A class for easily transversing a model heirarchy, applying an optional function at each level.
    **/
    class NDEVR_DESIGN_API BasicModelIterator : public ModelIterator
    {
    public:
        BasicModelIterator();
        explicit BasicModelIterator(const Model& model);
        explicit BasicModelIterator(const Buffer<Model>& models);
        explicit BasicModelIterator(const std::function<ParseResult(Model&, Geometry&)>& geo_callback);
        explicit BasicModelIterator(const std::function<ParseResult(Model&, Material&)>& material_callback);
        explicit BasicModelIterator(const std::function<ParseResult(Model&)>& model_callback);
        
        void setCallback(const std::function<ParseResult(Model&, Geometry&)>& geo_callback);
        void setCallback(const std::function<ParseResult(Model&, Material&)>& material_callback);
        void setCallback(const std::function<ParseResult(Model&)>& model_callback);
    protected:
        ParseResult process(Model& model) final override;
        ParseResult process(Model& model, Material& mat) final override;
        ParseResult process(Model& model, Geometry& geo) final override;
    protected:
        std::function<ParseResult(Model&, Geometry&)> m_geo_callback;
        std::function<ParseResult(Model&, Material&)> m_material_callback;
        std::function<ParseResult(Model&)> m_model_callback;
    };
}