dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r16960) -Doc: Added some viewport and vehicle type doxygen strings.

Browse Source
This commit is contained in:
alberth
2009-07-26 12:49:26 +00:00
parent d827a78ab7
commit 9caa2e941e
3 changed files with 31 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/window_gui.h
View File

@@ -189,14 +189,18 @@ enum SortButtonState {
};
/**
* Data structure for a window viewport
* Data structure for a window viewport.
* A viewport is either following a vehicle (its id in then in #follow_vehicle), or it aims to display a specific
* location #dest_scrollpos_x, #dest_scrollpos_y (#follow_vehicle is then #INVALID_VEHICLE).
* The actual location being shown is #scrollpos_x, #scrollpos_y.
* @see InitializeViewport(), UpdateViewportPosition().
*/
struct ViewportData : ViewPort {
VehicleID follow_vehicle;
int32 scrollpos_x;
int32 scrollpos_y;
int32 dest_scrollpos_x;
int32 dest_scrollpos_y;
VehicleID follow_vehicle; ///< VehicleID to follow if following a vehicle, #INVALID_VEHICLE otherwise.
int32 scrollpos_x; ///< Currently shown x coordinate (virtual screen coordinate of topleft corner of the viewport).
int32 scrollpos_y; ///< Currently shown y coordinate (virtual screen coordinate of topleft corner of the viewport).
int32 dest_scrollpos_x; ///< Current destination x coordinate to display (virtual screen coordinate of topleft corner of the viewport).
int32 dest_scrollpos_y; ///< Current destination y coordinate to display (virtual screen coordinate of topleft corner of the viewport).
};
/**