Formatting update
[sixth-3d.git] / src / main / java / eu / svjatoslav / sixth / e3d / gui / humaninput / MouseInteractionController.java
1 /*
2  * Sixth 3D engine. Author: Svjatoslav Agejenko. 
3  * This project is released under Creative Commons Zero (CC0) license.
4  */
5 package eu.svjatoslav.sixth.e3d.gui.humaninput;
6
7 public interface MouseInteractionController {
8
9     /**
10      * Called when mouse is clicked on component.
11      * @return <code>true</code> if view update is needed as a consequence of this mouse click.
12      */
13     boolean mouseClicked();
14
15     /**
16      * Called when mouse gets over given component.
17      * @return <code>true</code> if view update is needed as a consequence of this mouse enter.
18      */
19     boolean mouseEntered();
20
21     /**
22      * Called when mouse leaves screen area occupied by component.
23      * @return <code>true</code> if view update is needed as a consequence of this mouse exit.
24      */
25     boolean mouseExited();
26
27 }