OpenTTD Source  20241120-master-g6d3adc6169
ViewportSign Struct Reference

Location information about a sign as seen on the viewport. More...

#include <viewport_type.h>

Inheritance diagram for ViewportSign:
TextEffect TrackedViewportSign

Public Member Functions

auto operator<=> (const ViewportSign &) const =default
 
void UpdatePosition (int center, int top, StringID str, StringID str_small=STR_NULL)
 Update the position of the viewport sign. More...
 
void MarkDirty (ZoomLevel maxzoom=ZOOM_LVL_MAX) const
 Mark the sign dirty in all viewports. More...
 

Data Fields

int32_t center
 The center position of the sign.
 
int32_t top
 The top of the sign.
 
uint16_t width_normal
 The width when not zoomed out (normal font)
 
uint16_t width_small
 The width when zoomed out (small font)
 

Detailed Description

Location information about a sign as seen on the viewport.

Definition at line 38 of file viewport_type.h.

Member Function Documentation

◆ UpdatePosition()

void ViewportSign::UpdatePosition ( int  center,
int  top,
StringID  str,
StringID  str_small = STR_NULL 
)

Update the position of the viewport sign.

Parameters
centerthe (preferred) center of the viewport sign
topthe new top of the sign
strthe string to show in the sign
str_smallthe string to show when zoomed out. STR_NULL means same as str

Definition at line 1466 of file viewport.cpp.

References Align(), center, FS_SMALL, WidgetDimensions::fullbevel, GetString(), GetStringBoundingBox(), MarkDirty(), WidgetDimensions::scaled, top, width_normal, and width_small.

Referenced by TrackedViewportSign::UpdatePosition().


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