VehicleViewWindow Struct Reference

Window manager class for viewing a vehicle. More...

Inheritance diagram for VehicleViewWindow:

Window ZeroedMemoryAllocator

Public Member Functions

 VehicleViewWindow (const WindowDesc *desc, WindowNumber window_number)
virtual void UpdateWidgetSize (int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 Update size and resize step of a widget in the window.
virtual void OnPaint ()
 The window must be repainted.
virtual void SetStringParameters (int widget) const
 Initialize string parameters for a widget.
virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
virtual void OnClick (Point pt, int widget)
 A click with the left mouse button has been made on the window.
virtual void OnResize ()
 Called after the window got resized.
virtual void OnTick ()
 Called once per (game) tick.

Private Types

enum  PlaneSelections {
  SEL_DC_GOTO_DEPOT, SEL_DC_CLONE, SEL_RT_REFIT, SEL_RT_TURN_AROUND,
  SEL_DC_BASEPLANE = SEL_DC_GOTO_DEPOT, SEL_RT_BASEPLANE = SEL_RT_REFIT
}
 Display planes available in the vehicle view window. More...

Private Member Functions

void SelectPlane (PlaneSelections plane)
 Display a plane in the window.

Detailed Description

Window manager class for viewing a vehicle.

Definition at line 1841 of file vehicle_gui.cpp.


Member Enumeration Documentation

Display planes available in the vehicle view window.

Enumerator:
SEL_DC_GOTO_DEPOT  Display 'goto depot' button in VVW_WIDGET_SELECT_DEPOT_CLONE stacked widget.
SEL_DC_CLONE  Display 'clone vehicle' button in VVW_WIDGET_SELECT_DEPOT_CLONE stacked widget.
SEL_RT_REFIT  Display 'refit' button in VVW_WIDGET_SELECT_REFIT_TURN stacked widget.
SEL_RT_TURN_AROUND  Display 'turn around' button in VVW_WIDGET_SELECT_REFIT_TURN stacked widget.
SEL_DC_BASEPLANE  First plane of the VVW_WIDGET_SELECT_DEPOT_CLONE stacked widget.
SEL_RT_BASEPLANE  First plane of the VVW_WIDGET_SELECT_REFIT_TURN stacked widget.

Definition at line 1844 of file vehicle_gui.cpp.


Member Function Documentation

void VehicleViewWindow::SelectPlane ( PlaneSelections  plane  )  [inline, private]

Display a plane in the window.

Parameters:
plane Plane to show.

Definition at line 1858 of file vehicle_gui.cpp.

References SEL_DC_BASEPLANE, SEL_DC_CLONE, SEL_DC_GOTO_DEPOT, SEL_RT_BASEPLANE, SEL_RT_REFIT, SEL_RT_TURN_AROUND, VVW_WIDGET_SELECT_DEPOT_CLONE, and VVW_WIDGET_SELECT_REFIT_TURN.

virtual void VehicleViewWindow::UpdateWidgetSize ( int  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
) [inline, virtual]

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.
size Size of the widget.
padding Recommended amount of space between the widget content and the widget edge.
fill Fill step of the widget.
resize Resize step of the widget.

Reimplemented from Window.

Definition at line 1936 of file vehicle_gui.cpp.

References Dimension::height, VEH_TRAIN, VVW_WIDGET_VIEWPORT, and Dimension::width.

virtual void VehicleViewWindow::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 1953 of file vehicle_gui.cpp.

References SpecializedVehicle< Train, VEH_TRAIN >::From(), IsVehicleRefitable(), and VEH_TRAIN.

virtual void VehicleViewWindow::SetStringParameters ( int  widget  )  const [inline, virtual]

Initialize string parameters for a widget.

Calls to this function are made during initialization to measure the size (that is as part of InitNested()), during drawing, and while re-initializing the window. Only for widgets that render text initializing is requested.

Parameters:
widget Widget number.

Reimplemented from Window.

Definition at line 1972 of file vehicle_gui.cpp.

References SetDParam().

virtual void VehicleViewWindow::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 1980 of file vehicle_gui.cpp.

References _settings_client, DrawSprite(), DrawString(), SpecializedVehicle< Train, VEH_TRAIN >::From(), ClientSettings::gui, HasBit(), Rect::left, ODATFB_HALT, Rect::right, SA_CENTER, SetDParam(), Rect::top, VEH_AIRCRAFT, VEH_SHIP, VEH_TRAIN, GUISettings::vehicle_speed, WD_FRAMERECT_LEFT, and WD_FRAMERECT_TOP.

virtual void VehicleViewWindow::OnClick ( Point  pt,
int  widget 
) [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.

Reimplemented from Window.

Definition at line 2067 of file vehicle_gui.cpp.

References _ctrl_pressed, CcCloneVehicle(), CMD_FORCE_TRAIN_PROCEED, CMD_MSG, DEPOT_SERVICE, DoCommandP(), FindWindowById(), ViewportData::follow_vehicle, INVALID_VEH_ORDER_ID, ScrollMainWindowTo(), ShowVehicleDetailsWindow(), ShowVehicleRefitWindow(), VEH_ROAD, VEH_TRAIN, Window::viewport, and ViewPort::zoom.

virtual void VehicleViewWindow::OnResize (  )  [inline, virtual]

Called after the window got resized.

For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.

Reimplemented from Window.

Definition at line 2119 of file vehicle_gui.cpp.

References NWidgetViewport::UpdateViewportCoordinates(), and VVW_WIDGET_VIEWPORT.


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

Generated on Tue Jan 5 21:03:31 2010 for OpenTTD by  doxygen 1.5.6