Commit 59e7e38b authored by h2b's avatar h2b

Documentation updated.

parent 315f0bcd
......@@ -48,7 +48,23 @@ A `Screen` provides direct pixel graphics. It is the back end of `World`.
It can be used on its own if no world coordinate system is needed and bare screen-pixel coordinates shall be applied instead. Though, there are no fancy general shape-oriented `draw` and `fill` operations as `World` has to offer, but only some primitives like `setPixel`, `drawLine`, `drawSquare`, `fillSquare`, `moveTo` or `drawTo`.
(For details see the [API](#api).)
## Layout
Since version 1.1.0, a layout package is available that collects some tools for positioning elements on the screen.
It contains a `Cell` (a rectangular area) and a `GridLayout` of cells organized into rows and columns as this:
----------------------------
| cell | cell | cell | ... |
----------------------------
| cell | cell | cell | ... |
----------------------------
| cell | cell | cell | ... |
----------------------------
| ... | ... | ... | ... |
----------------------------
Various factory methods are provided that construct grid layouts from a sample cell, within a cell or on the whole screen.
## API
......
......@@ -20,6 +20,24 @@ package de.h2b.scala.lib.simgraf
/**
* A package collecting some tools for positioning elements on the screen.
*
* It contains a `Cell` (a rectangular area) and a `GridLayout` of cells
* organized into rows and columns as this:
*
* <pre>
* ----------------------------
* | cell | cell | cell | ... |
* ----------------------------
* | cell | cell | cell | ... |
* ----------------------------
* | cell | cell | cell | ... |
* ----------------------------
* | ... | ... | ... | ... |
* ----------------------------
* </pre>
*
* Various factory methods are provided that construct grid layouts from a
* sample cell, within a cell or on the whole screen.
*
* @since 1.1.0
* @author h2b
*/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment