DART  6.10.1
MouseEventHandler.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_GUI_OSG_MOUSEEVENTHANDLER_HPP_
34 #define DART_GUI_OSG_MOUSEEVENTHANDLER_HPP_
35 
37 #include "dart/common/Observer.hpp"
38 #include "dart/common/Subject.hpp"
39 
41 
42 namespace dart {
43 namespace gui {
44 namespace osg {
45 
46 class DefaultEventHandler;
47 
50  public virtual dart::common::Observer
51 {
52 public:
53  friend class DefaultEventHandler;
54 
55  inline MouseEventHandler() : mEventHandler(nullptr)
56  {
57  }
58 
61  virtual void update() = 0;
62 
63 protected:
64  void handleDestructionNotification(const Subject* _subject) override
65  {
66  if (mEventHandler == _subject)
67  delete this;
68  }
69 
71 };
73 
74 } // namespace osg
75 } // namespace gui
76 } // namespace dart
77 
78 #endif // DART_GUI_OSG_MOUSEEVENTHANDLER_HPP_
#define DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_END
Definition: ClassWithVirtualBase.hpp:44
#define DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_BEGIN
Definition: ClassWithVirtualBase.hpp:43
The Observer class should be inherited by any class that wants to respond in a customized way to the ...
Definition: Observer.hpp:52
friend class Subject
Definition: Observer.hpp:54
The Subject class is a base class for any object that wants to report when it gets destroyed.
Definition: Subject.hpp:58
Definition: DefaultEventHandler.hpp:106
Definition: MouseEventHandler.hpp:51
DefaultEventHandler * mEventHandler
Definition: MouseEventHandler.hpp:70
void handleDestructionNotification(const Subject *_subject) override
Definition: MouseEventHandler.hpp:64
MouseEventHandler()
Definition: MouseEventHandler.hpp:55
virtual void update()=0
Overload this function to set behavior that will get triggered during a mouse event.
Definition: BulletCollisionDetector.cpp:65