Visualization.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2020 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 IGNITION_GAZEBO_SYSTEMS_OPTICAL_TACTILE_PLUGIN_VISUALIZATION_HH_
#define IGNITION_GAZEBO_SYSTEMS_OPTICAL_TACTILE_PLUGIN_VISUALIZATION_HH_

#include <memory>
#include <string>

#include <ignition/gazebo/config.hh>
#include <ignition/gazebo/System.hh>
#include <ignition/msgs/marker.pb.h>

#include "ignition/gazebo/components/ContactSensorData.hh"

namespace ignition
{
namespace gazebo
{
// Inline bracket to help doxygen filtering.
inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE
{
namespace systems
{
namespace optical_tactile_sensor
{
  // This class handles the configuration and process of visualizing the
  // different elements needed for the Optical Tactile Sensor plugin.
  // Terminology:
  // "Contacts" refers to data from the contact sensor based on physics.
  // "Normal forces" refers to post-processed data from the depth camera based
  // purely on imagery.
  // These two sets of data are currently disjoint and visualized separately.
  class OpticalTactilePluginVisualization
  {
    public: OpticalTactilePluginVisualization(
        std::string &_modelName,
        ignition::math::Vector3d &_sensorSize,
        double &_forceLength,
        float &_cameraUpdateRate,
        ignition::math::Pose3f &_depthCameraOffset,
        int &_visualizationResolution);

    private: void InitializeSensorMarkerMsg(
        ignition::msgs::Marker &_sensorMarkerMsg);

    public: void RequestSensorMarkerMsg(
        ignition::math::Pose3f const &_sensorPose);

    private: void InitializeContactsMarkerMsg(
        ignition::msgs::Marker &_contactsMarkerMsg);

    public: void AddContactToMarkerMsg(
        ignition::msgs::Contact const &_contact,
        ignition::msgs::Marker &_contactsMarkerMsg);

    public: void RequestContactsMarkerMsg(
        components::ContactSensorData const *_contacts);

    private: void InitializeNormalForcesMarkerMsgs(
        ignition::msgs::Marker &_positionMarkerMsg,
        ignition::msgs::Marker &_forceMarkerMsg);

    public: void AddNormalForceToMarkerMsgs(
        ignition::msgs::Marker &_positionMarkerMsg,
        ignition::msgs::Marker &_forceMarkerMsg,
        ignition::math::Vector3f &_position,
        ignition::math::Vector3f &_normalForce,
        ignition::math::Pose3f &_sensorWorldPose);

    public: void RequestNormalForcesMarkerMsgs(
        ignition::msgs::Marker &_positionMarkerMsg,
        ignition::msgs::Marker &_forceMarkerMsg);

    public: void RemoveNormalForcesAndContactsMarkers();

    private: ignition::transport::Node node;

    private: std::string modelName;

    private: ignition::math::Vector3d sensorSize;

    private: double forceLength;

    private: float cameraUpdateRate;

    private: ignition::math::Pose3f depthCameraOffset;

    private: int visualizationResolution;

    private: bool normalForcesMsgsAreInitialized{false};
  };
}  // namespace optical_tactile_sensor
}  // namespace systems
}  // namespace IGNITION_GAZEBO_VERSION_NAMESPACE
}  // namespace gazebo
}  // namespace ignition

#endif