curioustorvald/Terrarum
1
0
Fork 0
mirror of https://github.com/curioustorvald/Terrarum.git synced 2026-06-16 21:44:05 +09:00
Code Issues Packages Projects Releases Wiki Activity

doc update for UICanvas and UIItem

Browse Source
This commit is contained in:
minjaesong
2019-02-17 18:17:30 +09:00
parent baeba1552a
commit ce010c1aa5
2 changed files with 35 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/net/torvald/terrarum/ui/UICanvas.kt
View File

@@ -11,9 +11,28 @@ import net.torvald.terrarum.roundInt
/**
* UIItems must be added manually at the init!
* ## UI Items
*
* FIXME: Bad design!!
* UI can contain one or more UI elements (called UIItem). Each UIItem can have one or more events programmed to it.
* Events have their own listener are governed by their GDX event handlers (e.g. mouseMoved).
* These GDX handlers are what makes the our own handler to work.
*
* UIItems have following event handlers: updateLister, keyDownListener, mouseMovedListener, touchDraggedListener, touchDownListener, touchUpListener, scrolledListener, and clickOnceListener.
* (perhaps clickOnceListener is the one most useful)
*
* To make them work without any hassle on your part,
* all the UIItems must be added to this UICanvas's ```uiItems``` list.
*
* See also: [net.torvald.terrarum.ui.UIItem]
*
* ## Sub UIs
*
* Sub UIs are UICanvases that is child of this UICanvas. They are also managed internally to lessen your burden.
* Just add all the Sub UIs using ```addSubUI()``` method.
*
* ## Position variables
*
* PosX/Y and relativeMouseX/Y are explained in ```work_files/terrarum_ui_elements_coord_explained.png```
*
* Created by minjaesong on 2015-12-31.
*/