GeometryFilter.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/SoftwareService.h>
#include <NDEVR/GeometryVertices.h>
#include <NDEVR/DesignCommand.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/UUID.h>
#include <NDEVR/GenericOption.h>
#include <NDEVR/Pointer.h>
 
namespace NDEVR
{
    class Model;
    class Geometry;
 
    /**--------------------------------------------------------------------------------------------------
    \brief Describes special options/parameters for a GeometryFilter engine
    **/
    struct NDEVR_DESIGN_API FilterDescription : public GenericOptionGroup
    {
        FilterDescription(const TranslatedString& filter_name, const String& filter_id);
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Stores a groups of options for performing GeometryFilter operations.
    **/
    struct NDEVR_DESIGN_API GeometryFilterParameters : public GenericOptionGroup, public GeometryVertices
    {
        GeometryFilterParameters();
        Matrix<fltp08> transform;
        const void* lock = nullptr;
        ProgressInfo* log = nullptr;
        Buffer<bool> filtered;
        Dictionary<UUID, Bounds<1, uint04>> vertex_bounds;
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief A service that contains registered algorithms for removing vertices or shapes from a group of
        vertices or shapes
    **/
    class NDEVR_DESIGN_API GeometryFilter : public SoftwareServiceManager, public SoftwareService
    {
    protected:
        explicit GeometryFilter(const TranslatedString& name, const String& id);
    public:
        static const Dictionary<String, GeometryFilter*>& AvailableFilters();
        static void AddAvailableFilter(GeometryFilter* filter);
        static void ExecuteFiltering(const JSONNode& active_filters, Model& model, ProgressInfo* log, const void* lock);
        static void ExecuteFiltering(const JSONNode& active_filters, const Matrix<fltp08>& transform, Geometry& geo, ProgressInfo* log, const void* lock);
        static Buffer<FilterDescription> GetAvailableDescriptions();
        static String ToCommandString(const Buffer<FilterDescription>& descriptions);
        static DynamicPointer<DesignCommand> AddFilterCommand(const FilterDescription& filter);
        static DynamicPointer<DesignCommand> SetFiltersCommand(const Buffer<FilterDescription>& filter);
    public:
        GeometryFilter(const GeometryFilter& filter) = delete;
        GeometryFilter(const GeometryFilter&& filter) = delete;
        virtual ~GeometryFilter() = default;
        virtual bool runFilter(GeometryFilterParameters& parameters) = 0;
        //Returns whether or not the filter can be applied given the target parameters. Default true
        virtual bool canRunFilter(const GeometryFilterParameters&) { return true; }
        virtual Buffer<FilterDescription> defaultFilterArguments();
        [[nodiscard]] const TranslatedString& filterName() const { return m_name; }
        [[nodiscard]] const String& filterID() const { return m_id; }
    protected:
        TranslatedString m_name;
        String m_id;
    protected:
        static void PrepareForFiltering(const Matrix<fltp08>& transform, Geometry& geo, GeometryFilterParameters& params);
        static void ClearAllFiltering(Geometry& geo, ProgressInfo* log, const void* lock);
        static void FinishFiltering(const Matrix<fltp08>& transform, Geometry& geo, const GeometryFilterParameters& params);
    protected:
        static Dictionary<String, GeometryFilter*> s_global_available_filters;
    };
}