tools.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef RVIZ_INTERACTIVE_MARKER_TOOLS_H
31 #define RVIZ_INTERACTIVE_MARKER_TOOLS_H
32 
33 #include <visualization_msgs/InteractiveMarker.h>
35 
36 namespace interactive_markers
37 {
38 
44 void autoComplete( visualization_msgs::InteractiveMarker &msg, bool enable_autocomplete_transparency = true );
45 
50 void autoComplete( const visualization_msgs::InteractiveMarker &msg,
51  visualization_msgs::InteractiveMarkerControl &control, bool enable_autocomplete_transparency = true );
52 
58 void uniqueifyControlNames( visualization_msgs::InteractiveMarker& msg );
59 
64 geometry_msgs::Quaternion makeQuaternion( float x, float y, float z );
65 
66 
68 
74 void makeArrow( const visualization_msgs::InteractiveMarker &msg,
75  visualization_msgs::InteractiveMarkerControl &control, float pos );
76 
81 void makeDisc( const visualization_msgs::InteractiveMarker &msg,
82  visualization_msgs::InteractiveMarkerControl &control, float width = 0.3 );
83 
88 void makeViewFacingButton( const visualization_msgs::InteractiveMarker &msg,
89  visualization_msgs::InteractiveMarkerControl &control, std::string text );
90 
93 void assignDefaultColor(visualization_msgs::Marker &marker, const geometry_msgs::Quaternion &quat );
94 
97 visualization_msgs::InteractiveMarkerControl makeTitle( const visualization_msgs::InteractiveMarker &msg );
98 
99 }
100 
101 #endif
interactive_markers::autoComplete
INTERACTIVE_MARKERS_PUBLIC void autoComplete(visualization_msgs::InteractiveMarker &msg, bool enable_autocomplete_transparency=true)
fill in default values & insert default controls when none are specified.
Definition: tools.cpp:44
interactive_markers::makeDisc
INTERACTIVE_MARKERS_PUBLIC void makeDisc(const visualization_msgs::InteractiveMarker &msg, visualization_msgs::InteractiveMarkerControl &control, float width=0.3)
make a default-style disc marker (e.g for rotating) based on the properties of the given interactive ...
Definition: tools.cpp:226
interactive_markers::uniqueifyControlNames
INTERACTIVE_MARKERS_PUBLIC void uniqueifyControlNames(visualization_msgs::InteractiveMarker &msg)
Make sure all the control names are unique within the given msg.
Definition: tools.cpp:83
INTERACTIVE_MARKERS_PUBLIC
#define INTERACTIVE_MARKERS_PUBLIC
Definition: visibility_control.hpp:64
interactive_markers::makeArrow
INTERACTIVE_MARKERS_PUBLIC void makeArrow(const visualization_msgs::InteractiveMarker &msg, visualization_msgs::InteractiveMarkerControl &control, float pos)
— marker helpers —
Definition: tools.cpp:198
interactive_markers::makeTitle
INTERACTIVE_MARKERS_PUBLIC visualization_msgs::InteractiveMarkerControl makeTitle(const visualization_msgs::InteractiveMarker &msg)
create a control which shows the description of the interactive marker
Definition: tools.cpp:419
interactive_markers::makeQuaternion
INTERACTIVE_MARKERS_PUBLIC geometry_msgs::Quaternion makeQuaternion(float x, float y, float z)
interactive_markers::makeViewFacingButton
INTERACTIVE_MARKERS_PUBLIC void makeViewFacingButton(const visualization_msgs::InteractiveMarker &msg, visualization_msgs::InteractiveMarkerControl &control, std::string text)
make a box which shows the given text and is view facing
Definition: tools.cpp:369
visibility_control.hpp
interactive_markers
Definition: message_context.h:45
interactive_markers::assignDefaultColor
INTERACTIVE_MARKERS_PUBLIC void assignDefaultColor(visualization_msgs::Marker &marker, const geometry_msgs::Quaternion &quat)
assign an RGB value to the given marker based on the given orientation
Definition: tools.cpp:396


interactive_markers
Author(s): David Gossow, William Woodall
autogenerated on Fri Oct 27 2023 02:31:54