DefaultEventHandler.hpp

/*
 * Copyright (c) 2011-2021, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/master/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   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.
 *   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 HOLDER 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 DART_GUI_OSG_DEFAULTEVENTHANDLER_HPP_
#define DART_GUI_OSG_DEFAULTEVENTHANDLER_HPP_

#include <array>
#include <memory>
#include <vector>

#include <Eigen/Core>

#include <osgGA/GUIEventHandler>

#include "dart/common/ClassWithVirtualBase.hpp"
#include "dart/common/Observer.hpp"
#include "dart/common/Subject.hpp"

namespace dart {

namespace dynamics {
class Shape;
class ShapeFrame;
class Entity;
} // namespace dynamics

namespace gui {
namespace osg {

struct PickInfo
{
  dart::dynamics::ShapeFrame* frame;
  std::shared_ptr<dart::dynamics::Shape> shape;
  Eigen::Vector3d position;
  Eigen::Vector3d normal;
};

class Viewer;

enum MouseButton
{

  LEFT_MOUSE = 0,
  RIGHT_MOUSE,
  MIDDLE_MOUSE,

  NUM_MOUSE_BUTTONS
};

enum MouseButtonEvent
{

  BUTTON_PUSH = 0,
  BUTTON_DRAG,
  BUTTON_RELEASE,
  BUTTON_NOTHING

};

enum ConstraintType
{

  UNCONSTRAINED = 0,
  LINE_CONSTRAINT,
  PLANE_CONSTRAINT,
  CUSTOM_CONSTRAINT,

  NUM_CONSTRAINT_TYPES
};

class MouseEventHandler;

DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_BEGIN
class DefaultEventHandler : public ::osgGA::GUIEventHandler,
                            public virtual dart::common::Subject,
                            public virtual dart::common::Observer
{
public:
  explicit DefaultEventHandler(Viewer* _viewer);

  virtual ~DefaultEventHandler();

  MouseButtonEvent getButtonEvent(MouseButton button) const;

  int getModKeyMask() const;

  double getWindowCursorX() const;

  double getWindowCursorY() const;

  Eigen::Vector3d getDeltaCursor(
      const Eigen::Vector3d& _fromPosition,
      ConstraintType _constraint = UNCONSTRAINED,
      const Eigen::Vector3d& _constraintVector
      = Eigen::Vector3d::UnitZ()) const;

  void getNearAndFarPointUnderCursor(
      Eigen::Vector3d& near, Eigen::Vector3d& far, double distance = 1.0) const;

  const std::vector<PickInfo>& getButtonPicks(
      MouseButton button, MouseButtonEvent event) const;

  const std::vector<PickInfo>& getMovePicks() const;

  void suppressButtonPicks(MouseButton button, MouseButtonEvent event);

  void suppressMovePicks();

  void activateButtonPicks(MouseButton button, MouseButtonEvent event);

  void activateMovePicks();

  void pick(
      std::vector<PickInfo>& infoVector, const ::osgGA::GUIEventAdapter& ea);

  void addMouseEventHandler(MouseEventHandler* handler);

  const std::set<MouseEventHandler*>& getMouseEventHandlers() const;

  bool handle(
      const ::osgGA::GUIEventAdapter& ea, ::osgGA::GUIActionAdapter&) override;

protected:
  void triggerMouseEventHandlers();

  void eventPick(const ::osgGA::GUIEventAdapter& ea);

  void clearButtonEvents();

  void handleDestructionNotification(
      const dart::common::Subject* _subject) override;

  Viewer* mViewer;

  std::set<MouseEventHandler*> mMouseEventHandlers;

  std::vector<PickInfo> mButtonPicks[NUM_MOUSE_BUTTONS][BUTTON_NOTHING];

  bool mSuppressButtonPicks[NUM_MOUSE_BUTTONS][BUTTON_NOTHING];

  std::vector<PickInfo> mMovePicks;

  bool mSuppressMovePicks;

  std::vector<PickInfo> mTempPicks;

  MouseButtonEvent mLastButtonEvent[NUM_MOUSE_BUTTONS];

  Eigen::Vector2d mLastCursorPosition;

  int mLastModKeyMask;
};
DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_END

} // namespace osg
} // namespace gui
} // namespace dart

#endif // DART_GUI_OSG_DEFAULTEVENTHANDLER_HPP_