ScenarioEditorLandscapeGenerationWindow Struct Reference

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

Inheritance diagram for ScenarioEditorLandscapeGenerationWindow:

Public Member Functions
	ScenarioEditorLandscapeGenerationWindow (WindowDesc &desc, WindowNumber window_number)
void	OnPaint () override
	The window must be repainted.
void	UpdateWidgetSize (WidgetID widget, Dimension &size, const Dimension &padding, Dimension &fill, Dimension &resize) override
	Update size and resize step of a widget in the window.
void	DrawWidget (const Rect &r, WidgetID widget) const override
	Draw the contents of a nested widget.
void	OnClick (Point pt, WidgetID widget, int click_count) override
	A click with the left mouse button has been made on the window.
void	OnTimeout () override
	Called when this window's timeout has been reached.
void	OnPlaceObject (Point pt, TileIndex tile) override
	The user clicked some place on the map when a tile highlight mode has been set.
void	OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt) override
	The user is dragging over the map when the tile highlight mode has been set.
void	OnPlaceMouseUp (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile) override
	The user has dragged over the map when the tile highlight mode has been set.
void	OnPlaceObjectAbort () override
	The user cancelled a tile highlight mode that has been set.
Public Member Functions inherited from Window
	Window (WindowDesc &desc)
	Empty constructor, initialization has been moved to InitNested() called from the constructor of the derived class.
void *	operator new[] (size_t size)=delete
	Helper allocation function to disallow something.
template<class NWID >
const NWID *	GetWidget (WidgetID widnum) const
	Get the nested widget with number widnum from the nested widget tree.
template<class NWID >
NWID *	GetWidget (WidgetID widnum)
	Get the nested widget with number widnum from the nested widget tree.
const Scrollbar *	GetScrollbar (WidgetID widnum) const
	Return the Scrollbar to a widget index.
Scrollbar *	GetScrollbar (WidgetID widnum)
	Return the Scrollbar to a widget index.
const QueryString *	GetQueryString (WidgetID widnum) const
	Return the querystring associated to a editbox.
QueryString *	GetQueryString (WidgetID widnum)
	Return the querystring associated to a editbox.
void	UpdateQueryStringSize ()
	Update size of all QueryStrings of this window.
virtual const struct Textbuf *	GetFocusedTextbuf () const
	Get the current input text buffer.
virtual Point	GetCaretPosition () const
	Get the current caret position if an edit box has the focus.
virtual Rect	GetTextBoundingRect (const char *from, const char *to) const
	Get the bounding rectangle for a text range if an edit box has the focus.
virtual ptrdiff_t	GetTextCharacterAtPosition (const Point &pt) const
	Get the character that is rendered at a position by the focused edit box.
void	InitNested (WindowNumber number=0)
	Perform complete initialization of the Window with nested widgets, to allow use.
void	CreateNestedTree ()
	Perform the first part of the initialization of a nested widget tree.
void	FinishInitNested (WindowNumber window_number=0)
	Perform the second part of the initialization of a nested widget tree.
template<typename T , std::enable_if_t< std::is_base_of< StrongTypedefBase, T >::value, int > = 0>
void	FinishInitNested (T number)
void	SetTimeout ()
	Set the timeout flag of the window and initiate the timer.
void	SetWhiteBorder ()
	Set the timeout flag of the window and initiate the timer.
void	DisableAllWidgetHighlight ()
	Disable the highlighted status of all widgets.
void	SetWidgetHighlight (WidgetID widget_index, TextColour highlighted_colour)
	Sets the highlighted status of a widget.
bool	IsWidgetHighlighted (WidgetID widget_index) const
	Gets the highlighted status of a widget.
void	SetWidgetDisabledState (WidgetID widget_index, bool disab_stat)
	Sets the enabled/disabled status of a widget.
void	DisableWidget (WidgetID widget_index)
	Sets a widget to disabled.
void	EnableWidget (WidgetID widget_index)
	Sets a widget to Enabled.
bool	IsWidgetDisabled (WidgetID widget_index) const
	Gets the enabled/disabled status of a widget.
bool	IsWidgetFocused (WidgetID widget_index) const
	Check if given widget is focused within this window.
bool	IsWidgetGloballyFocused (WidgetID widget_index) const
	Check if given widget has user input focus.
void	SetWidgetLoweredState (WidgetID widget_index, bool lowered_stat)
	Sets the lowered/raised status of a widget.
void	ToggleWidgetLoweredState (WidgetID widget_index)
	Invert the lowered/raised status of a widget.
void	LowerWidget (WidgetID widget_index)
	Marks a widget as lowered.
void	RaiseWidget (WidgetID widget_index)
	Marks a widget as raised.
void	RaiseWidgetWhenLowered (WidgetID widget_index)
	Marks a widget as raised and dirty (redraw), when it is marked as lowered.
bool	IsWidgetLowered (WidgetID widget_index) const
	Gets the lowered state of a widget.
void	UnfocusFocusedWidget ()
	Makes no widget on this window have focus.
bool	SetFocusedWidget (WidgetID widget_index)
	Set focus within this window to the given widget.
EventState	HandleEditBoxKey (WidgetID wid, char32_t key, uint16_t keycode)
	Process keypress for editbox widget.
virtual void	InsertTextString (WidgetID wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
	Insert a text string at the cursor position into the edit box widget.
void	HandleButtonClick (WidgetID widget)
	Do all things to make a button look clicked and mark it to be unclicked in a few ticks.
int	GetRowFromWidget (int clickpos, WidgetID widget, int padding, int line_height=-1) const
	Compute the row of a widget that a user clicked in.
void	RaiseButtons (bool autoraise=false)
	Raise the buttons of the window.
template<typename... Args>
void	SetWidgetsDisabledState (bool disab_stat, Args... widgets)
	Sets the enabled/disabled status of a list of widgets.
template<typename... Args>
void	SetWidgetsLoweredState (bool lowered_stat, Args... widgets)
	Sets the lowered/raised status of a list of widgets.
template<typename... Args>
void	RaiseWidgetsWhenLowered (Args... widgets)
	Raises the widgets and sets widgets dirty that are lowered.
void	SetWidgetDirty (WidgetID widget_index) const
	Invalidate a widget, i.e.
void	DrawWidgets () const
	Paint all widgets of a window.
void	DrawViewport () const
	Draw the viewport of this window.
void	DrawSortButtonState (WidgetID widget, SortButtonState state) const
	Draw a sort button's up or down arrow symbol.
Window *	FindChildWindow (WindowClass wc=WC_INVALID) const
	Find the Window whose parent pointer points to this window.
void	CloseChildWindows (WindowClass wc=WC_INVALID) const
	Close all children a window might have in a head-recursive manner.
virtual void	Close (int data=0)
	Hide the window and all its child windows, and mark them for a later deletion.
void	SetDirty () const
	Mark entire window as dirty (in need of re-paint)
void	ReInit (int rx=0, int ry=0, bool reposition=false)
	Re-initialize a window, and optionally change its size.
bool	IsShaded () const
	Is window shaded currently?
void	SetShaded (bool make_shaded)
	Set the shaded state of the window to make_shaded.
void	ScheduleResize ()
	Mark this window as resized and in need of OnResize() event.
void	ProcessScheduledResize ()
	Process scheduled OnResize() event.
void	InvalidateData (int data=0, bool gui_scope=true)
	Mark this window's data as invalid (in need of re-computing)
void	ProcessScheduledInvalidations ()
	Process all scheduled invalidations.
void	ProcessHighlightedInvalidations ()
	Process all invalidation of highlighted widgets.
virtual void	OnInit ()
	Notification that the nested widget tree gets initialized.
virtual void	ApplyDefaults ()
	Read default values from WindowDesc configuration an apply them to the window.
virtual Point	OnInitialPosition (int16_t sm_width, int16_t sm_height, int window_number)
	Compute the initial position of the window.
virtual void	SetStringParameters (WidgetID widget) const
	Initialize string parameters for a widget.
virtual void	OnFocus ()
	The window has gained focus.
virtual void	OnFocusLost (bool closing)
	The window has lost focus.
virtual EventState	OnKeyPress (char32_t key, uint16_t keycode)
	A key has been pressed.
virtual EventState	OnHotkey (int hotkey)
	A hotkey has been pressed.
virtual EventState	OnCTRLStateChange ()
	The state of the control key has changed.
virtual bool	OnRightClick (Point pt, WidgetID widget)
	A click with the right mouse button has been made on the window.
virtual void	OnHover (Point pt, WidgetID widget)
	The mouse is hovering over a widget in the window, perform an action for it.
virtual bool	OnTooltip (Point pt, WidgetID widget, TooltipCloseCondition close_cond)
	Event to display a custom tooltip.
virtual void	OnMouseDrag (Point pt, WidgetID widget)
	An 'object' is being dragged at the provided position, highlight the target if possible.
virtual void	OnDragDrop (Point pt, WidgetID widget)
	A dragged 'object' has been released.
virtual void	OnScroll (Point delta)
	Handle the request for (viewport) scrolling.
virtual void	OnMouseOver (Point pt, WidgetID widget)
	The mouse is currently moving over the window or has just moved outside of the window.
virtual void	OnMouseWheel (int wheel)
	The mouse wheel has been turned.
virtual void	OnMouseLoop ()
	Called for every mouse loop run, which is at least once per (game) tick.
virtual void	OnGameTick ()
	Called once per (game) tick.
virtual void	OnRealtimeTick (uint delta_ms)
	Called periodically.
virtual void	OnResize ()
	Called after the window got resized.
virtual void	OnDropdownSelect (WidgetID widget, int index)
	A dropdown option associated to this window has been selected.
virtual void	OnDropdownClose (Point pt, WidgetID widget, int index, bool instant_close)
	A dropdown window associated to this window has been closed.
virtual void	OnEditboxChanged (WidgetID widget)
	The text in an editbox has been edited.
virtual void	OnQueryTextFinished (std::optional< std::string > str)
	The query window opened from this window has closed.
virtual void	OnInvalidateData (int data=0, bool gui_scope=true)
	Some data on this window has become invalid.
virtual bool	OnVehicleSelect (const struct Vehicle *v)
	The user clicked on a vehicle while HT_VEHICLE has been set.
virtual bool	OnVehicleSelect (VehicleList::const_iterator begin, VehicleList::const_iterator end)
	The user clicked on a vehicle while HT_VEHICLE has been set.
virtual void	OnPlacePresize (Point pt, TileIndex tile)
	The user moves over the map when a tile highlight mode has been set when the special mouse mode has been set to 'PRESIZE' mode.
virtual bool	IsNewGRFInspectable () const
	Is the data related to this window NewGRF inspectable?
virtual void	ShowNewGRFInspectWindow () const
	Show the NewGRF inspection window.
template<>
const NWidgetBase *	GetWidget (WidgetID widnum) const
	Specialized case of Window::GetWidget for the nested widget base class.
Public Member Functions inherited from ZeroedMemoryAllocator
void *	operator new (size_t size)
	Memory allocator for a single class instance.
void *	operator new[] (size_t size)
	Memory allocator for an array of class instances.
void	operator delete (void *ptr)
	Memory release for a single class instance.
void	operator delete[] (void *ptr)
	Memory release for an array of class instances.

Static Public Member Functions
static EventState	TerraformToolbarEditorGlobalHotkeys (int hotkey)
	Handler for global hotkeys of the ScenarioEditorLandscapeGenerationWindow.
Static Public Member Functions inherited from Window
static int	SortButtonWidth ()
	Get width of up/down arrow of sort button state.
static void	DeleteClosedWindows ()
	Delete all closed windows.

Data Fields
int	last_user_action
	Last started user action.
Data Fields inherited from Window
WindowDesc &	window_desc
	Window description.
WindowFlags	flags
	Window flags.
WindowClass	window_class
	Window class.
WindowNumber	window_number
	Window number within the window class.
int	scale
	Scale of this window – used to determine how to resize.
uint8_t	timeout_timer
	Timer value of the WF_TIMEOUT for flags.
uint8_t	white_border_timer
	Timer value of the WF_WHITE_BORDER for flags.
int	left
	x position of left edge of the window
int	top
	y position of top edge of the window
int	width
	width of the window (number of pixels to the right in x direction)
int	height
	Height of the window (number of pixels down in y direction)
ResizeInfo	resize
	Resize information.
Owner	owner
	The owner of the content shown in this window. Company colour is acquired from this variable.
ViewportData *	viewport
	Pointer to viewport data, if present.
const NWidgetCore *	nested_focus
	Currently focused nested widget, or nullptr if no nested widget has focus.
std::map< WidgetID, QueryString * >	querystrings
	QueryString associated to WWT_EDITBOX widgets.
std::unique_ptr< NWidgetBase >	nested_root
	Root of the nested tree.
WidgetLookup	widget_lookup
	Indexed access to the nested widget tree. Do not access directly, use Window::GetWidget() instead.
NWidgetStacked *	shade_select
	Selection widget (NWID_SELECTION) to use for shading the window. If nullptr, window cannot shade.
Dimension	unshaded_size
	Last known unshaded size (only valid while shaded).
WidgetID	mouse_capture_widget
	ID of current mouse capture widget (e.g. dragged scrollbar). -1 if no widget has mouse capture.
Window *	parent
	Parent window.
WindowList::iterator	z_position

Static Public Attributes
static HotkeyList	hotkeys

Additional Inherited Members
Public Types inherited from Window
using	IteratorToFront = WindowIterator< false >
	Iterate in Z order towards front.
using	IteratorToBack = WindowIterator< true >
	Iterate in Z order towards back.
using	Iterate = AllWindows< false >
	Iterate all windows in whatever order is easiest.
using	IterateFromBack = AllWindows< false >
	Iterate all windows in Z order from back to front.
using	IterateFromFront = AllWindows< true >
	Iterate all windows in Z order from front to back.
Protected Member Functions inherited from Window
void	InitializeData (WindowNumber window_number)
	Initializes the data (except the position and initial size) of a new Window.
void	InitializePositionSize (int x, int y, int min_width, int min_height)
	Set the position and smallest size of the window.
virtual void	FindWindowPlacementAndResize (int def_width, int def_height)
	Resize window towards the default size.
virtual	~Window ()
	Remove window and all its child windows from the window stack.
Protected Attributes inherited from Window
std::vector< int >	scheduled_invalidation_data
	Data of scheduled OnInvalidateData() calls.
bool	scheduled_resize
	Set if window has been resized.

Detailed Description

Landscape generation window handler in the scenario editor.

Definition at line 536 of file terraform_gui.cpp.

Constructor & Destructor Documentation

ScenarioEditorLandscapeGenerationWindow()

ScenarioEditorLandscapeGenerationWindow::ScenarioEditorLandscapeGenerationWindow ( WindowDesc &  desc, WindowNumber  window_number  )

inline

Definition at line 539 of file terraform_gui.cpp.

Member Function Documentation

DrawWidget()

void ScenarioEditorLandscapeGenerationWindow::DrawWidget ( const Rect &  r, WidgetID  widget  ) const

inlineoverridevirtual

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 565 of file terraform_gui.cpp.

References DrawSprite(), Window::GetWidget(), RoundDivSU(), ScaleGUITrad(), and WID_ETT_DOTS.

OnClick()

void ScenarioEditorLandscapeGenerationWindow::OnClick ( Point  pt, WidgetID  widget, int  click_count  )

inlineoverridevirtual

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 582 of file terraform_gui.cpp.

References _settings_client, ANIMCURSOR_DEMOLISH, ANIMCURSOR_LOWERLAND, ANIMCURSOR_RAISELAND, SoundSettings::click_beep, Window::GetWidget(), Window::HandleButtonClick(), HandlePlacePushButton(), HT_DIAGONAL, HT_POINT, HT_RECT, IsInsideMM(), ResetLandscapeConfirmationCallback(), Window::SetDirty(), ShowBuildObjectPicker(), ShowCreateScenario(), ShowQuery(), SND_15_BEEP, ClientSettings::sound, WID_ETT_BUTTONS_START, WID_ETT_DECREASE_SIZE, WID_ETT_DEMOLISH, WID_ETT_INCREASE_SIZE, WID_ETT_LEVEL_LAND, WID_ETT_LOWER_LAND, WID_ETT_NEW_SCENARIO, WID_ETT_PLACE_DESERT, WID_ETT_PLACE_OBJECT, WID_ETT_PLACE_ROCKS, WID_ETT_RAISE_LAND, and WID_ETT_RESET_LANDSCAPE.

OnPaint()

void ScenarioEditorLandscapeGenerationWindow::OnPaint ( )

inlineoverridevirtual

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 548 of file terraform_gui.cpp.

References Window::DrawWidgets(), Window::IsWidgetLowered(), SetTileSelectSize(), WID_ETT_LOWER_LAND, and WID_ETT_RAISE_LAND.

OnPlaceDrag()

void ScenarioEditorLandscapeGenerationWindow::OnPlaceDrag ( ViewportPlaceMethod  select_method, ViewportDragDropSelectionProcess  select_proc, Point  pt  )

inlineoverridevirtual

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 687 of file terraform_gui.cpp.

References Window::GetWidget(), and VpSelectTilesWithMethod().

OnPlaceMouseUp()

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

inlineoverridevirtual

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 692 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, Window::GetWidget(), and GUIPlaceProcDragXY().

OnPlaceObject()

void ScenarioEditorLandscapeGenerationWindow::OnPlaceObject ( Point  pt, TileIndex  tile  )

inlineoverridevirtual

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 656 of file terraform_gui.cpp.

References CommonRaiseLowerBigLand(), DDSP_CREATE_DESERT, DDSP_CREATE_ROCKS, DDSP_LEVEL_AREA, PlaceProc_DemolishArea(), VPM_X_AND_Y, VpStartPlaceSizing(), WID_ETT_DEMOLISH, WID_ETT_LEVEL_LAND, WID_ETT_LOWER_LAND, WID_ETT_PLACE_DESERT, WID_ETT_PLACE_ROCKS, and WID_ETT_RAISE_LAND.

OnPlaceObjectAbort()

void ScenarioEditorLandscapeGenerationWindow::OnPlaceObjectAbort ( )

inlineoverridevirtual

The user cancelled a tile highlight mode that has been set.

Reimplemented from Window.

Definition at line 709 of file terraform_gui.cpp.

References Window::RaiseButtons(), and Window::SetDirty().

OnTimeout()

void ScenarioEditorLandscapeGenerationWindow::OnTimeout ( )

inlineoverridevirtual

Called when this window's timeout has been reached.

Reimplemented from Window.

Definition at line 648 of file terraform_gui.cpp.

References Window::GetWidget(), Window::RaiseWidgetWhenLowered(), WID_ETT_BUTTONS_END, WID_ETT_BUTTONS_START, WID_ETT_START, and Window::widget_lookup.

TerraformToolbarEditorGlobalHotkeys()

static EventState ScenarioEditorLandscapeGenerationWindow::TerraformToolbarEditorGlobalHotkeys ( int  hotkey )

inlinestatic

Handler for global hotkeys of the ScenarioEditorLandscapeGenerationWindow.

Parameters

hotkey

Hotkey

Returns

ES_HANDLED if hotkey was accepted.

Definition at line 720 of file terraform_gui.cpp.

References ES_NOT_HANDLED, Window::GetWidget(), Window::OnHotkey(), and ShowEditorTerraformToolbar().

UpdateWidgetSize()

void ScenarioEditorLandscapeGenerationWindow::UpdateWidgetSize ( WidgetID  widget, Dimension &  size, const Dimension &  padding, Dimension &  fill, Dimension &  resize  )

inlineoverridevirtual

Update size and resize step of a widget in the window.

After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.

Parameters

	widget	Widget number.
[in,out]	size	Size of the widget.
	padding	Recommended amount of space between the widget content and the widget edge.
[in,out]	fill	Fill step of the widget.
[in,out]	resize	Resize step of the widget.

Reimplemented from Window.

Definition at line 557 of file terraform_gui.cpp.

References ScaleGUITrad(), and WID_ETT_DOTS.

Field Documentation

hotkeys

HotkeyList ScenarioEditorLandscapeGenerationWindow::hotkeys

inlinestatic

Initial value:

{"terraform_editor", {
    Hotkey('D' | WKC_GLOBAL_HOTKEY, "dynamite", WID_ETT_DEMOLISH),
    Hotkey('Q' | WKC_GLOBAL_HOTKEY, "lower", WID_ETT_LOWER_LAND),
    Hotkey('W' | WKC_GLOBAL_HOTKEY, "raise", WID_ETT_RAISE_LAND),
    Hotkey('E' | WKC_GLOBAL_HOTKEY, "level", WID_ETT_LEVEL_LAND),
    Hotkey('R', "rocky", WID_ETT_PLACE_ROCKS),
    Hotkey('T', "desert", WID_ETT_PLACE_DESERT),
    Hotkey('O', "object", WID_ETT_PLACE_OBJECT),
  }, TerraformToolbarEditorGlobalHotkeys}

Definition at line 728 of file terraform_gui.cpp.

last_user_action

int ScenarioEditorLandscapeGenerationWindow::last_user_action

Last started user action.

Definition at line 537 of file terraform_gui.cpp.

---

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

• src/terraform_gui.cpp