src/systems/logical_audio_sensor_plugin/LogicalAudio.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 GZ_SIM_SYSTEMS_LOGICAL_AUDIO_SENSOR_PLUGIN_LOGICALAUDIO_HH_
#define GZ_SIM_SYSTEMS_LOGICAL_AUDIO_SENSOR_PLUGIN_LOGICALAUDIO_HH_
 
#include <string>
 
#include <gz/sim/components/LogicalAudio.hh>
#include <gz/sim/config.hh>
#include <gz/sim/logicalaudiosensorplugin-system/Export.hh>
#include <gz/math/Pose3.hh>
 
namespace gz
{
namespace sim
{
// Inline bracket to help doxygen filtering.
inline namespace GZ_SIM_VERSION_NAMESPACE {
namespace logical_audio
{
  GZ_SIM_LOGICALAUDIOSENSORPLUGIN_SYSTEM_VISIBLE
  bool detect(double _volumeLevel, double _volumeDetectionThreshold);
 
  GZ_SIM_LOGICALAUDIOSENSORPLUGIN_SYSTEM_VISIBLE
  double computeVolume(bool _playing,
      AttenuationFunction _attenuationFunc,
      AttenuationShape _attenuationShape,
      double _sourceEmissionVolume,
      double _innerRadius,
      double _falloffDistance,
      const gz::math::Pose3d &_sourcePose,
      const gz::math::Pose3d &_targetPose);
 
  GZ_SIM_LOGICALAUDIOSENSORPLUGIN_SYSTEM_VISIBLE
  void setAttenuationFunction(AttenuationFunction &_attenuationFunc,
      std::string _str);
 
  GZ_SIM_LOGICALAUDIOSENSORPLUGIN_SYSTEM_VISIBLE
  void setAttenuationShape(AttenuationShape &_attenuationShape,
      std::string _str);
 
  GZ_SIM_LOGICALAUDIOSENSORPLUGIN_SYSTEM_VISIBLE
  void validateInnerRadiusAndFalloffDistance(double &_innerRadius,
      double &_falloffDistance);
 
  GZ_SIM_LOGICALAUDIOSENSORPLUGIN_SYSTEM_VISIBLE
  void validateVolumeLevel(double &_volumeLevel);
}
}
}
}
 
#endif