OpenTTD Source 20261112-master-gbcbec5e63f
CargoChainField Class Reference

Field representing cargo names. More...

Inheritance diagram for CargoChainField:
ChainField

Public Member Functions

 CargoChainField (std::span< const CargoType > cargo_types, Alignment align)
 Construct a new cargo label chain field.
void Draw (Rect r) const override
 Draw the field.
ClickedAtResult ClickedAt (Rect r, Point pt) const override
 Decide which industry/house or cargo was clicked at.
Public Member Functions inherited from ChainField
template<typename T>
T * Get ()
 Get this field as a specific type implemention.
template<typename T>
const T * Get () const
 Get this field as a specific type implemention.
virtual int Width () const
 Get the width of this field.
virtual int Height () const
 Get the height of this field.

Data Fields

std::array< CargoType, ChainField::MAX_CARGOES > cargo_types
 Cargoes to display (or INVALID_CARGO).
Alignment align
 The text alignment.

Additional Inherited Members

Public Types inherited from ChainField
using CargoSlotMask = uint16_t
 Type representing a mask of cargo slots.
using ClickedAtResult = std::variant<std::monostate, HouseID, IndustryType, CargoType>
 Result type of testing clicked position.
Static Public Member Functions inherited from ChainField
static uint GetConnectionHeight ()
 Get the height of all cargo connections in a row.
Static Public Attributes inherited from ChainField
static constexpr uint MAX_CARGOES = 16
 Maximum number of cargoes carried in a field.
static constexpr CargoSlotMask ALL_CARGO_SLOTS {std::numeric_limits<CargoSlotMask>::max()}
 Value representing all cargo slots.
static constexpr PixelColour CARGO_LINE_COLOUR = PC_BLACK
 Line colour around the cargo.
static FontSize fontsize = FontSize::Normal
 Font size of industry chain strings.
static CargoTypes town_accepts
 Mask of cargo types accepted by towns.
static CargoTypes town_produces
 Mask of cargo types produced by towns.
static int vert_inter_industry_space
 Amount of space between two industries in a column.
static int blob_distance
 Distance of the industry legend colour from the edge of the industry box.
static Dimension legend
 Dimension of the legend blob.
static Dimension cargo_border
 Dimensions of border between cargo lines and industry boxes.
static Dimension cargo_line
 Dimensions of cargo lines.
static Dimension cargo_space
 Dimensions of space between cargo lines.
static Dimension cargo_stub
 Dimensions of cargo stub (unconnected cargo line.).
static int small_height
 Height of the header row.
static int normal_height
 Height of the non-header rows.
static int connection_field_width
 Width of a cargo connection field.
static int industry_width
 Width of an industry field.
static uint max_cargoes
 Largest number of cargoes actually on any industry.

Detailed Description

Field representing cargo names.

Definition at line 2438 of file industry_gui.cpp.

Constructor & Destructor Documentation

◆ CargoChainField()

CargoChainField::CargoChainField ( std::span< const CargoType > cargo_types,
Alignment align )
inline

Construct a new cargo label chain field.

Parameters
cargo_typesThe cargo types of this label field.
alignThe text alignment.

Definition at line 2448 of file industry_gui.cpp.

References align, cargo_types, and INVALID_CARGO.

Member Function Documentation

◆ ClickedAt()

ClickedAtResult CargoChainField::ClickedAt ( Rect r,
Point pt ) const
inlineoverridevirtual

Decide which industry/house or cargo was clicked at.

Parameters
rRect of this cargo field.
ptClick position in the cargo field.
Returns
Industry/house or cargo clicked at.

Reimplemented from ChainField.

Definition at line 2468 of file industry_gui.cpp.

References ChainField::cargo_line, ChainField::cargo_space, Rect::CentreToHeight(), Rect::Contains(), ChainField::fontsize, GetCharacterHeight(), ChainField::GetConnectionHeight(), IsValidCargoType(), Point, Rect::Translate(), and Rect::WithHeight().

◆ Draw()

Field Documentation

◆ align

Alignment CargoChainField::align

The text alignment.

Definition at line 2441 of file industry_gui.cpp.

Referenced by CargoChainField().

◆ cargo_types

std::array<CargoType, ChainField::MAX_CARGOES> CargoChainField::cargo_types

Cargoes to display (or INVALID_CARGO).

Definition at line 2440 of file industry_gui.cpp.

Referenced by CargoChainField().


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