interaction_tool.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef RVIZ_INTERACTION_TOOL_H
#define RVIZ_INTERACTION_TOOL_H

#include "rviz/tools/tool.h"
#include "rviz/properties/forwards.h"
#include "rviz/selection/forwards.h"
#include "rviz/selection/selection_handler.h"

#include "ros/subscriber.h"

namespace rviz
{
class VisualizationManager;

class InteractionTool : public Tool
{
public:
  InteractionTool( const std::string& name, char shortcut_key, rviz::VisualizationManager* manager );
  virtual ~InteractionTool();

  virtual void activate();
  virtual void deactivate();

  virtual int processMouseEvent( rviz::ViewportMouseEvent& event );

  virtual void update(float wall_dt, float ros_dt);

  virtual bool hasProperties() { return true; }
  virtual void enumerateProperties(rviz::PropertyManager* property_manager, const rviz::CategoryPropertyWPtr& parent);

protected:

  void updateSelection( SelectionHandlerPtr &focused_handler, ViewportMouseEvent event );

  // handle of the currently focused object
  Picked focused_object_;

  // handle of the ViewControllerHandler we're creating
  CollObjectHandle view_controller_handle_;
  SelectionHandlerPtr view_controller_handler_;

  uint64_t last_selection_frame_count_;
};

}

#endif