1

/* $Id$ */

     2

     3

/** @file viewport_func.h Functions related to (drawing on) viewports. */

     4

     5

#ifndef VIEWPORT_FUNC_H

     6

#define VIEWPORT_FUNC_H

     7

     8

#include "gfx_type.h"

     9

#include "viewport_type.h"

    10

#include "vehicle_type.h"

    11

#include "strings_type.h"

    12

    13

void SetSelectionRed(bool);

    14

    15

void DeleteWindowViewport(Window *w);

    17

ViewPort *IsPtInWindowViewport(const Window *w, int x, int y);

    18

Point GetTileBelowCursor();

    19

void UpdateViewportPosition(Window *w);

    20

    21

bool DoZoomInOutWindow(int how, Window *w);

    22

void ZoomInOrOutToCursorWindow(bool in, Window * w);

    23

Point GetTileZoomCenterWindow(bool in, Window * w);

    24

void HandleZoomMessage(Window *w, const ViewPort *vp, byte widget_zoom_in, byte widget_zoom_out);

    25

    26

static inline void MaxZoomInOut(int how, Window *w)

    27

{

    28

	while (DoZoomInOutWindow(how, w)) {};

    29

}

    30

    31

void OffsetGroundSprite(int x, int y);

    32

    33

void DrawGroundSprite(SpriteID image, SpriteID pal, const SubSprite *sub = NULL);

    34

void DrawGroundSpriteAt(SpriteID image, SpriteID pal, int32 x, int32 y, byte z, const SubSprite *sub = NULL);

    35

void AddSortableSpriteToDraw(SpriteID image, SpriteID pal, int x, int y, int w, int h, int dz, int z, bool transparent = false, int bb_offset_x = 0, int bb_offset_y = 0, int bb_offset_z = 0, const SubSprite *sub = NULL);

    36

void AddStringToDraw(int x, int y, StringID string, uint64 params_1, uint64 params_2, uint16 color = 0, uint16 width = 0);

    37

void AddChildSpriteScreen(SpriteID image, SpriteID pal, int x, int y, bool transparent = false, const SubSprite *sub = NULL);

    38

    39

    40

void StartSpriteCombine();

    41

void EndSpriteCombine();

    42

    43

void HandleViewportClicked(const ViewPort *vp, int x, int y);

    44

void PlaceObject();

    45

void SetRedErrorSquare(TileIndex tile);

    46

void SetTileSelectSize(int w, int h);

    47

void SetTileSelectBigSize(int ox, int oy, int sx, int sy);

    48

    49

Vehicle *CheckMouseOverVehicle();

    50

    51

void VpSelectTilesWithMethod(int x, int y, ViewportPlaceMethod method);

    52

void VpStartPlaceSizing(TileIndex tile, ViewportPlaceMethod method, byte process);

    53

void VpSetPresizeRange(TileIndex from, TileIndex to);

    54

void VpSetPlaceSizingLimit(int limit);

    55

    56

typedef void PlaceProc(TileIndex tile);

    57

void PlaceProc_DemolishArea(TileIndex tile);

    58

void PlaceProc_LevelLand(TileIndex tile);

    59

void PlaceProc_BuyLand(TileIndex tile);

    60

bool GUIPlaceProcDragXY(const WindowEvent *e);

    61

    62

/* common button handler */

    63

bool HandlePlacePushButton(Window *w, int widget, CursorID cursor, ViewportHighlightMode mode, PlaceProc *placeproc);

    64

    65

void ViewportDoDraw(const ViewPort *vp, int left, int top, int right, int bottom);

    66

    67

void SetObjectToPlaceWnd(CursorID icon, SpriteID pal, ViewportHighlightMode mode, Window *w);

    68

void SetObjectToPlace(CursorID icon, SpriteID pal, ViewportHighlightMode mode, WindowClass window_class, WindowNumber window_num);

    69

    70

void ResetObjectToPlace();

    71

    72

bool ScrollWindowTo(int x, int y, Window *w, bool instant = false);

    73

    74

bool ScrollMainWindowToTile(TileIndex tile, bool instant = false);

    75

bool ScrollMainWindowTo(int x, int y, bool instant = false);

    76

    77

extern PlaceProc *_place_proc;

    78

extern Point _tile_fract_coords;

    79

extern TileHighlightData _thd;

    80

    81

#endif /* VIEWPORT_FUNC_H */