Public Member Functions | List of all members
gazebo::util::OpenALSink Class Reference

OpenAL Listener. More...

#include <OpenAL.hh>

Public Member Functions

 OpenALSink ()
 Constructor. More...
 
virtual ~OpenALSink ()
 Destructor. More...
 
bool SetPose (const math::Pose &_pose) GAZEBO_DEPRECATED(6.0)
 Set the position of the sink. More...
 
bool SetPose (const ignition::math::Pose3d &_pose)
 Set the position of the sink. More...
 
bool SetVelocity (const math::Vector3 &_vel) GAZEBO_DEPRECATED(6.0)
 Set the velocity of the sink. More...
 
bool SetVelocity (const ignition::math::Vector3d &_vel)
 Set the velocity of the sink. More...
 

Detailed Description

OpenAL Listener.

This can be thought of as a microphone.

Constructor & Destructor Documentation

gazebo::util::OpenALSink::OpenALSink ( )

Constructor.

virtual gazebo::util::OpenALSink::~OpenALSink ( )
virtual

Destructor.

Member Function Documentation

bool gazebo::util::OpenALSink::SetPose ( const math::Pose _pose)

Set the position of the sink.

Parameters
[in]_poseNew pose of the sink.
Returns
True on success.
Deprecated:
See SetPose function that accepts an ignition::math::Pose3d object.
bool gazebo::util::OpenALSink::SetPose ( const ignition::math::Pose3d &  _pose)

Set the position of the sink.

Parameters
[in]_poseNew pose of the sink.
Returns
True on success.
bool gazebo::util::OpenALSink::SetVelocity ( const math::Vector3 _vel)

Set the velocity of the sink.

Parameters
[in]_velVelocity of the sink.
Returns
True on success.
Deprecated:
See SetVelocity function that accepts an ignition::math::Vector3d object.
bool gazebo::util::OpenALSink::SetVelocity ( const ignition::math::Vector3d &  _vel)

Set the velocity of the sink.

Parameters
[in]_velVelocity of the sink.
Returns
True on success.

The documentation for this class was generated from the following file: