LinkPlot3DPlugin.hh

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GAZEBO_PLUGINS_LINKPLOT3DPLUGIN_HH_
#define GAZEBO_PLUGINS_LINKPLOT3DPLUGIN_HH_

#include <memory>

#include "gazebo/common/Plugin.hh"

namespace gazebo
{
  // Forward declare private data class
  class LinkPlot3DPluginPrivate;

  /// \brief A plugin that traces the trajectory of a link in the rendering
  /// scene.
  ///
  /// The plugin takes the following elements:
  ///
  /// * <frequency>: Frequency in Hertz in which to update the plot
  /// * <plot>: One plot element per link to be plotted in this model. It takes
  ///           the following sub elements:
  ///     * <link>: Link scoped name.
  ///     * <pose>: Pose of point to plot, expressed in the link frame.
  ///     * <material>: Material for the 3D line.
  ///
  /// Example from plot3d.world:
  ///
  ///    <plugin name='3dplot' filename='libLinkPlot3DPlugin.so'>
  ///
  ///      <!-- Update at 10 Hz -->
  ///      <frequency>10</frequency>
  ///
  ///      <!-- Upper link plot -->
  ///      <plot>
  ///        <link>double_pendulum_with_base::upper_link</link>
  ///
  ///        <!-- Point 1m in +Z axis in link frame -->
  ///        <pose>0 0 1 0 0 0</pose>
  ///
  ///        <material>Gazebo/Red</material>
  ///      </plot>
  ///
  ///      <!-- Upper link plot -->
  ///      <plot>
  ///        <link>double_pendulum_with_base::lower_link</link>
  ///
  ///        <!-- Point 1m in +Z axis in link frame -->
  ///        <pose>0 0 1 0 0 0</pose>
  ///
  ///        <material>Gazebo/Blue</material>
  ///      </plot>
  ///
  ///    </plugin>
  class GZ_PLUGIN_VISIBLE LinkPlot3DPlugin : public ModelPlugin
  {
    /// \brief Constructor.
    public: LinkPlot3DPlugin();

    /// \brief Destructor.
    public: ~LinkPlot3DPlugin();

    // Documentation Inherited.
    public: virtual void Load(physics::ModelPtr _model, sdf::ElementPtr _sdf);

    /// \brief Callback for World Update events.
    private: virtual void OnUpdate();

    // Private data pointer.
    private: std::unique_ptr<LinkPlot3DPluginPrivate> dataPtr;
  };
}
#endif