diff options
Diffstat (limited to 'src/zoom_type.h')
-rw-r--r-- | src/zoom_type.h | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/src/zoom_type.h b/src/zoom_type.h index e2698ae48..8b5761408 100644 --- a/src/zoom_type.h +++ b/src/zoom_type.h @@ -14,36 +14,37 @@ #include "core/enum_type.hpp" +/** All zoom levels we know. */ enum ZoomLevel { /* Our possible zoom-levels */ - ZOOM_LVL_BEGIN = 0, - ZOOM_LVL_NORMAL = 0, - ZOOM_LVL_OUT_2X, - ZOOM_LVL_OUT_4X, - ZOOM_LVL_OUT_8X, - ZOOM_LVL_END, + ZOOM_LVL_BEGIN = 0, ///< Begin for iteration. + ZOOM_LVL_NORMAL = 0, ///< The normal zoom level. + ZOOM_LVL_OUT_2X, ///< Zoomed 2 times out. + ZOOM_LVL_OUT_4X, ///< Zoomed 4 times out. + ZOOM_LVL_OUT_8X, ///< Zoomed 8 times out. + ZOOM_LVL_END, ///< End for iteration. - /* Number of zoom levels */ - ZOOM_LVL_COUNT = ZOOM_LVL_END - ZOOM_LVL_BEGIN, + ZOOM_LVL_COUNT = ZOOM_LVL_END - ZOOM_LVL_BEGIN, ///< Number of zoom levels. /* Here we define in which zoom viewports are */ - ZOOM_LVL_VIEWPORT = ZOOM_LVL_NORMAL, - ZOOM_LVL_NEWS = ZOOM_LVL_NORMAL, - ZOOM_LVL_INDUSTRY = ZOOM_LVL_OUT_2X, - ZOOM_LVL_TOWN = ZOOM_LVL_OUT_2X, - ZOOM_LVL_AIRCRAFT = ZOOM_LVL_NORMAL, - ZOOM_LVL_SHIP = ZOOM_LVL_NORMAL, - ZOOM_LVL_TRAIN = ZOOM_LVL_NORMAL, - ZOOM_LVL_ROADVEH = ZOOM_LVL_NORMAL, - ZOOM_LVL_WORLD_SCREENSHOT = ZOOM_LVL_NORMAL, + ZOOM_LVL_VIEWPORT = ZOOM_LVL_NORMAL, ///< Default zoom level for viewports. + ZOOM_LVL_NEWS = ZOOM_LVL_NORMAL, ///< Default zoom level for the news messages. + ZOOM_LVL_INDUSTRY = ZOOM_LVL_OUT_2X, ///< Default zoom level for the industry view. + ZOOM_LVL_TOWN = ZOOM_LVL_OUT_2X, ///< Default zoom level for the town view. + ZOOM_LVL_AIRCRAFT = ZOOM_LVL_NORMAL, ///< Default zoom level for the aircraft view. + ZOOM_LVL_SHIP = ZOOM_LVL_NORMAL, ///< Default zoom level for the ship view. + ZOOM_LVL_TRAIN = ZOOM_LVL_NORMAL, ///< Default zoom level for the train view. + ZOOM_LVL_ROADVEH = ZOOM_LVL_NORMAL, ///< Default zoom level for the road vehicle view. + ZOOM_LVL_WORLD_SCREENSHOT = ZOOM_LVL_NORMAL, ///< Default zoom level for the world screen shot. ZOOM_LVL_DETAIL = ZOOM_LVL_OUT_2X, ///< All zoomlevels below or equal to this, will result in details on the screen, like road-work, ... - ZOOM_LVL_MIN = ZOOM_LVL_NORMAL, - ZOOM_LVL_MAX = ZOOM_LVL_OUT_8X, + ZOOM_LVL_MIN = ZOOM_LVL_NORMAL, ///< Minimum zoom level. + ZOOM_LVL_MAX = ZOOM_LVL_OUT_8X, ///< Maximum zoom level. }; DECLARE_POSTFIX_INCREMENT(ZoomLevel) +/** Type for storing the zoom level in a byte. */ typedef SimpleTinyEnumT<ZoomLevel, byte> ZoomLevelByte; #endif /* ZOOM_TYPE_H */ |