GeometryRegistration.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/Model.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/RGBColor.h>
#include <NDEVR/GenericOption.h>
 
namespace NDEVR
{
    class Geometry;
    template<uint01 t_dims, class t_type> class RTree;
    /**--------------------------------------------------------------------------------------------------
    \brief Describes special options/parameters for a GeometryRegistration engine
    **/
    struct NDEVR_DESIGN_API GeometryRegistrationDescription : public GenericOptionGroup
    {
        GeometryRegistrationDescription(const TranslatedString& name, const String& filter_id);
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Describes options/parameters for running the GeometryRegistration
    **/
    struct NDEVR_DESIGN_API GeometryRegistrationParameters : public GenericOptionGroup
    {
        GeometryRegistrationParameters();
        Buffer<Matrix<fltp08>> potential_a_to_b_transform;
        const void* lock = nullptr;
        ProgressInfo* log = nullptr;
        Matrix<fltp08> reference_transform;
        GeometryVertices reference;
        Buffer<GeometryVertices> registration_points;
        Buffer<Matrix<fltp08>> original_transforms;
        std::function<void(uint04 iteration_a, uint04 iteration_b, Matrix<fltp08>& mat, bool finished)> update_data_callback;
 
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief A service that contains registered algorithms for registering geometry such that the input is
        adjusted to match the output. See https://en.wikipedia.org/wiki/Point-set_registration. 
    **/
    class NDEVR_DESIGN_API GeometryRegistration : public SoftwareServiceManager, public SoftwareService
    {
    protected:
        explicit GeometryRegistration(const String& name, const String& id);
 
    public:
        static const Dictionary<String, GeometryRegistration*>& AvailableRegistrationEngines();
        static void AddAvailableRegistrationEngine(GeometryRegistration* filter);
        static void ExecuteRegistration(const JSONNode& active_filters, const Buffer<Model>& models_to_register, const Buffer<Model>& reference_models, ProgressInfo* log, const void* lock);
        static Buffer<GeometryRegistrationDescription> GetAvailableDescriptions();
        static String ToCommandString(const Buffer<GeometryRegistrationDescription>& descriptions);
        static DynamicPointer<DesignCommand> RegistrationCommand(const UUID& reference, const GeometryRegistrationDescription& filter);
    public:
        GeometryRegistration(const GeometryRegistration& filter) = delete;
        GeometryRegistration(const GeometryRegistration&& filter) = delete;
    public://Override These Functions
        virtual ~GeometryRegistration() = default;
        virtual bool runRegistration(GeometryRegistrationParameters& parameters) = 0;
        //Returns whether or not the filter can be applied given the target parameters. Default true
        virtual bool canRunRegistration(const GeometryRegistrationParameters&) { return true; }
        virtual Buffer<GeometryRegistrationDescription> defaultRegistrationArguments();
    public:
        [[nodiscard]] const TranslatedString& registrationName() const { return m_name; }
        [[nodiscard]] const String& registrationID() const { return m_id; }
    protected:
        TranslatedString m_name;
        String m_id;
    protected:
        static void PrepareForRegistration(const Matrix<fltp08>& transform, const Geometry& geo, GeometryRegistrationParameters& params, bool is_reference);
        static void FinishRegistration(const Matrix<fltp08>& transform, Geometry& geo, const GeometryRegistrationParameters& params);
    protected:
        static Dictionary<String, GeometryRegistration*> s_global_available_registration_engines;
    };
}