game_view_layout Class Reference

The layout of the Game dialog. More...

#include <game_view_layout.h>

Public Member Functions
	game_view_layout (const screen_rect &r=get_default_screen_rect(), const int margin_width=get_default_margin_width())
const auto &	get_background () const noexcept
	The entire screen.
const auto &	get_board () const noexcept
const in_game_controls_layout &	get_controls (const side player) const noexcept
const screen_rect &	get_debug (const side player) const noexcept
const auto &	get_game_info () const noexcept
const screen_rect &	get_log (const side player) const noexcept
	The area where the frame rate (in frames per seconds) is dsplayed.
const navigation_controls_layout &	get_navigation_controls (const side player) const noexcept
const screen_rect &	get_unit_info (const side player) const noexcept
	Information about a unit.

Detailed Description

The layout of the Game dialog.

The layout of the Game dialog (game_view}).

  x          x x        x x      x x          x
  1          2 3        4 5      6 7          8
 
+-----------------------------------------------+
|                                               |
| +----------+ +-----------------+ +----------+ | y1
| | unit     | |                 | | unit     | |
| |          | |                 | |          | |
| |          | |                 | |          | |
| | info     | |                 | | info     | |
| +----------+ | board           | +----------+ | y2
| | controls | |                 | | controls | |
| |          | |                 | |          | |
| |          | |                 | |          | |
| |          | +-----------------+ |          | |
| |          |                     |          | |
| |          | +-----------------+ |          | | y3
| |          | | game_statistics | |          | |
| +----------+ +-----------------+ +----------+ | y4
|                                               |
| +---------------------+ +-------------------+ | y5
| | log                 | | log               | |
| +---------------------+ +-------------------+ | y6
|                                               |
| +---------------------+ +-------------------+ | y7
| | debug               | | debug             | |
| +---------------------+ +-------------------+ | y8
|                                               |
+-----------------------------------------------+
 
  ^          ^ ^            ^  ^          ^
  |          | |            |  |          |
  +----------+ +------------+  +----------+
   panel_width  board_width     panel_width
    300 pixels   remainder       300 pixels

Constructor & Destructor Documentation

game_view_layout()

game_view_layout::game_view_layout ( const screen_rect &  r = get_default_screen_rect(), const int  margin_width = get_default_margin_width()  )

explicit

2 for the ASDW, then 1 per action key

Member Function Documentation

get_background()

const auto & game_view_layout::get_background ( ) const

inlinenoexcept

The entire screen.

get_board()

const auto & game_view_layout::get_board ( ) const

inlinenoexcept

get_controls()

const in_game_controls_layout & game_view_layout::get_controls ( const side  player ) const

noexcept

get_debug()

const screen_rect & game_view_layout::get_debug ( const side  player ) const

noexcept

get_game_info()

const auto & game_view_layout::get_game_info ( ) const

inlinenoexcept

get_log()

const screen_rect & game_view_layout::get_log ( const side  player ) const

noexcept

The area where the frame rate (in frames per seconds) is dsplayed.

get_navigation_controls()

const navigation_controls_layout & game_view_layout::get_navigation_controls ( const side  player ) const

noexcept

get_unit_info()

const screen_rect & game_view_layout::get_unit_info ( const side  player ) const

noexcept

Information about a unit.

---

The documentation for this class was generated from the following files:

• include/game_view_layout.h
• src/game_view_layout.cpp