custom_decoration_generator.h

Go to the documentation of this file.

#pragma once
 
#include <functional>
 
namespace osc { struct SceneDecoration; }
namespace SimTK { class State; }
 
namespace opyn
{
    // an interface for an object that generates decorations in an OSC-specific custom way
    //
    // i.e. if an `OpenSim::Component` implements this, it should take precedence over `Component::generateDecorations`
    class CustomDecorationGenerator {
    protected:
        CustomDecorationGenerator() = default;
        CustomDecorationGenerator(const CustomDecorationGenerator&) = default;
        CustomDecorationGenerator(CustomDecorationGenerator&&) noexcept = default;
        CustomDecorationGenerator& operator=(const CustomDecorationGenerator&) = default;
        CustomDecorationGenerator& operator=(CustomDecorationGenerator&&) noexcept = default;
    public:
        virtual ~CustomDecorationGenerator() noexcept = default;
 
        void generateCustomDecorations(
            const SimTK::State& state,
            const std::function<void(osc::SceneDecoration&&)>& callback) const
        {
            implGenerateCustomDecorations(state, callback);
        }
    private:
        virtual void implGenerateCustomDecorations(
            const SimTK::State&,
            const std::function<void(osc::SceneDecoration&&)>&
        ) const = 0;
    };
}