Restored JavaDoc support
[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / gui / humaninput / MouseInteractionController.java
1 /*
2  * Sixth 3D engine. Copyright ©2012-2019, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of version 3 of the GNU Lesser General Public License
6  * or later as published by the Free Software Foundation.
7  *
8  */
9
10 package eu.svjatoslav.sixth.e3d.gui.humaninput;
11
12 public interface MouseInteractionController {
13
14     /**
15      * Called when mouse is clicked on component.
16      * @return <code>true</code> if view update is needed as a consequence of this mouse click.
17      */
18     boolean mouseClicked();
19
20     /**
21      * Called when mouse gets over given component.
22      * @return <code>true</code> if view update is needed as a consequence of this mouse enter.
23      */
24     boolean mouseEntered();
25
26     /**
27      * Called when mouse leaves screen area occupied by component.
28      * @return <code>true</code> if view update is needed as a consequence of this mouse exit.
29      */
30     boolean mouseExited();
31
32 }