rviz_plugin_display: comments in CMakeLists.txt, removed some unnecessary stuff, and began adding wiki tags to imu_display source.

Author: hershwg

rviz_plugin_tutorials/CMakeLists.txt

@@ -11,16 +11,23 @@ set(ROS_BUILD_TYPE RelWithDebInfo)
 
 rosbuild_init()
 
-find_package(Qt4 COMPONENTS QtCore QtGui QtOpenGL REQUIRED)
+# This plugin includes Qt widgets, so we must include Qt like so:
+find_package(Qt4 COMPONENTS QtCore QtGui REQUIRED)
 include(${QT_USE_FILE})
 
+# I prefer the Qt signals and slots to avoid defining "emit", "slots",
+# etc because they can conflict with boost signals.
 add_definitions(-DQT_NO_KEYWORDS)
 
+# Here we specify which header files need to be run through "moc",
+# Qt's meta-object compiler.
 qt4_wrap_cpp(MOC_FILES
   src/drive_widget.h
   src/teleop_panel.h
 )
 
+# Here we specify the list of source files, including the output of
+# the previous command which is stored in ${MOC_FILES}.
 set(SOURCE_FILES
   src/drive_widget.cpp
   src/teleop_panel.cpp 
@@ -35,5 +42,9 @@ set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
 #set the default path for built libraries to the "lib" directory
 set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)
 
+# An rviz plugin is just a shared library, so here we declare the
+# library and specify the list of source files we collected above.
 rosbuild_add_library(${PROJECT_NAME} ${SOURCE_FILES})
-target_link_libraries(${PROJECT_NAME} ${QT_LIBRARIES} ${OGRE_LIBRARIES})
+
+# Link the library
+target_link_libraries(${PROJECT_NAME} ${QT_LIBRARIES})

rviz_plugin_tutorials/src/imu_display.h

@@ -26,6 +26,7 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
+// %Tag(FULL_SOURCE)%
 #ifndef IMU_DISPLAY_H
 #define IMU_DISPLAY_H
 
@@ -140,3 +141,4 @@ class ImuDisplay: public rviz::Display
 } // end namespace rviz_plugin_tutorials
 
 #endif // IMU_DISPLAY_H
+// %EndTag(FULL_SOURCE)%