ScenarioEditorLandscapeGenerationWindow Struct Reference

Landscape generation window handler in the scenario editor. More...

Inheritance diagram for ScenarioEditorLandscapeGenerationWindow:
Window ZeroedMemoryAllocator

Public Member Functions

 ScenarioEditorLandscapeGenerationWindow (const WindowDesc *desc, WindowNumber window_number)
virtual void OnPaint ()
 The window must be repainted.
virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
virtual EventState OnKeyPress (uint16 key, uint16 keycode)
 A key has been pressed.
virtual void OnClick (Point pt, int widget, int click_count)
 A click with the left mouse button has been made on the window.
virtual void OnTimeout ()
 Called when this window's timeout has been reached.
virtual void OnPlaceObject (Point pt, TileIndex tile)
 The user clicked some place on the map when a tile highlight mode has been set.
virtual void OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
 The user is dragging over the map when the tile highlight mode has been set.
virtual void OnPlaceMouseUp (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
 The user has dragged over the map when the tile highlight mode has been set.
virtual void OnPlaceObjectAbort ()
 The user cancelled a tile highlight mode that has been set.

Data Fields

int last_user_action
 Last started user action.

Static Public Attributes

static Hotkey
< ScenarioEditorLandscapeGenerationWindow
terraform_editor_hotkeys []

Detailed Description

Landscape generation window handler in the scenario editor.

Definition at line 576 of file terraform_gui.cpp.


Member Function Documentation

virtual void ScenarioEditorLandscapeGenerationWindow::DrawWidget ( const Rect r,
int  widget 
) const [inline, virtual]

Draw the contents of a nested widget.

Parameters:
r Rectangle occupied by the widget.
widget Number of the widget to draw.
Note:
This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 597 of file terraform_gui.cpp.

References DrawSprite(), ETTW_DOTS, and RoundDivSU().

virtual void ScenarioEditorLandscapeGenerationWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
) [inline, virtual]

A click with the left mouse button has been made on the window.

Parameters:
pt the point inside the window that has been clicked.
widget the clicked widget.
click_count Number of fast consecutive clicks at same position

Reimplemented from Window.

Definition at line 622 of file terraform_gui.cpp.

References ANIMCURSOR_DEMOLISH, ANIMCURSOR_LOWERLAND, ANIMCURSOR_RAISELAND, ETTW_BUTTONS_START, ETTW_DECREASE_SIZE, ETTW_DEMOLISH, ETTW_INCREASE_SIZE, ETTW_LEVEL_LAND, ETTW_LOWER_LAND, ETTW_NEW_SCENARIO, ETTW_PLACE_DESERT, ETTW_PLACE_OBJECT, ETTW_PLACE_ROCKS, ETTW_RAISE_LAND, ETTW_RESET_LANDSCAPE, Window::HandleButtonClick(), HandlePlacePushButton(), HT_DIAGONAL, HT_POINT, HT_RECT, IsInsideMM(), last_user_action, ResetLandscapeConfirmationCallback(), Window::SetDirty(), ShowBuildObjectPicker(), ShowCreateScenario(), and ShowQuery().

Referenced by OnKeyPress().

virtual EventState ScenarioEditorLandscapeGenerationWindow::OnKeyPress ( uint16  key,
uint16  keycode 
) [inline, virtual]

A key has been pressed.

Parameters:
key the Unicode value of the key.
keycode the untranslated key code including shift state.
Returns:
ES_HANDLED if the key press has been handled and no other window should receive the event.

Reimplemented from Window.

Definition at line 614 of file terraform_gui.cpp.

References CheckHotkeyMatch(), ES_HANDLED, ES_NOT_HANDLED, and OnClick().

virtual void ScenarioEditorLandscapeGenerationWindow::OnPaint (  )  [inline, virtual]

The window must be repainted.

Note:
This method should not change any state, it should only use drawing functions.

Reimplemented from Window.

Definition at line 588 of file terraform_gui.cpp.

References Window::DrawWidgets(), ETTW_LOWER_LAND, ETTW_RAISE_LAND, Window::IsWidgetLowered(), and SetTileSelectSize().

virtual void ScenarioEditorLandscapeGenerationWindow::OnPlaceDrag ( ViewportPlaceMethod  select_method,
ViewportDragDropSelectionProcess  select_proc,
Point  pt 
) [inline, virtual]

The user is dragging over the map when the tile highlight mode has been set.

Parameters:
select_method the method of selection (allowed directions)
select_proc what will be created when the drag is over.
pt the exact point on the map where the mouse is.

Reimplemented from Window.

Definition at line 737 of file terraform_gui.cpp.

References VpSelectTilesWithMethod().

virtual void ScenarioEditorLandscapeGenerationWindow::OnPlaceMouseUp ( ViewportPlaceMethod  select_method,
ViewportDragDropSelectionProcess  select_proc,
Point  pt,
TileIndex  start_tile,
TileIndex  end_tile 
) [inline, virtual]

The user has dragged over the map when the tile highlight mode has been set.

Parameters:
select_method the method of selection (allowed directions)
select_proc what should be created.
pt the exact point on the map where the mouse was released.
start_tile the begin tile of the drag.
end_tile the end tile of the drag.

Reimplemented from Window.

Definition at line 742 of file terraform_gui.cpp.

References DDSP_CREATE_DESERT, DDSP_CREATE_ROCKS, DDSP_DEMOLISH_AREA, DDSP_LEVEL_AREA, DDSP_LOWER_AND_LEVEL_AREA, DDSP_RAISE_AND_LEVEL_AREA, and GUIPlaceProcDragXY().

virtual void ScenarioEditorLandscapeGenerationWindow::OnPlaceObject ( Point  pt,
TileIndex  tile 
) [inline, virtual]

The user clicked some place on the map when a tile highlight mode has been set.

Parameters:
pt the exact point on the map that has been clicked.
tile the tile on the map that has been clicked.

Reimplemented from Window.

Definition at line 702 of file terraform_gui.cpp.

References CommonRaiseLowerBigLand(), DDSP_CREATE_DESERT, DDSP_CREATE_ROCKS, DDSP_LEVEL_AREA, ETTW_DEMOLISH, ETTW_LEVEL_LAND, ETTW_LOWER_LAND, ETTW_PLACE_DESERT, ETTW_PLACE_OBJECT, ETTW_PLACE_ROCKS, ETTW_RAISE_LAND, last_user_action, PlaceProc_DemolishArea(), PlaceProc_Object(), VPM_X_AND_Y, and VpStartPlaceSizing().


Field Documentation

Hotkey< ScenarioEditorLandscapeGenerationWindow > ScenarioEditorLandscapeGenerationWindow::terraform_editor_hotkeys [static]

The documentation for this struct was generated from the following file:

Generated on Fri May 27 04:21:10 2011 for OpenTTD by  doxygen 1.6.1