ArVizComponentPlugin.h

Go to the documentation of this file.

#pragma once
 
#include <ArmarXCore/core/ComponentPlugin.h>
 
#include <RobotAPI/components/ArViz/Client/Client.h>
 
namespace armarx::plugins
{
    class ArVizComponentPlugin : public ComponentPlugin
    {
    public:
        using ComponentPlugin::ComponentPlugin;
 
        void preOnInitComponent() override;
 
        void preOnConnectComponent() override;
 
        void postCreatePropertyDefinitions(PropertyDefinitionsPtr& properties) override;
 
        armarx::viz::Client createClient();
 
        std::string getTopicName();
 
        std::string getStorageName();
    };
}
 
 
#include <ArmarXCore/core/ManagedIceObject.h>
 
namespace armarx
{
    /**
     * @brief Provides a ready-to-use ArViz client `arviz` as member variable.
     */
    class ArVizComponentPluginUser : virtual public ManagedIceObject
    {
    public:
        ArVizComponentPluginUser();
 
        armarx::viz::Client createArVizClient();
 
        armarx::viz::Client arviz;
 
        armarx::viz::Client& getArvizClient()
        {
            return arviz;
        }
 
    private:
        armarx::plugins::ArVizComponentPlugin* plugin = nullptr;
    };
}
 
 
namespace armarx::plugins
{
    // Legacy typedef.
    using ArVizComponentPluginUser = armarx::ArVizComponentPluginUser;
}