OpenTTD Source 20261112-master-gbcbec5e63f
AcceptsProducesChainField Class Referenceabstract

Field representing something that accepts and produces cargo. More...

Inheritance diagram for AcceptsProducesChainField:
ChainField HouseChainField IndustryChainField

Public Member Functions

 AcceptsProducesChainField ()
 Construct a new Accepts/Produces 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.
virtual CargoTypes GetProduced ()=0
 Connected the cargo types produced by this field.
virtual CargoTypes GetAccepted ()=0
 Connected the cargo types accepted by this field.
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 > other_produced
 Cargoes produced but not used in this figure.
std::array< CargoType, ChainField::MAX_CARGOES > other_accepted
 Cargoes accepted but not used in this figure.

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 something that accepts and produces cargo.

Definition at line 2260 of file industry_gui.cpp.

Constructor & Destructor Documentation

◆ AcceptsProducesChainField()

AcceptsProducesChainField::AcceptsProducesChainField ( )
inline

Construct a new Accepts/Produces chain field.

Definition at line 2268 of file industry_gui.cpp.

References INVALID_CARGO.

Member Function Documentation

◆ ClickedAt()

ClickedAtResult AcceptsProducesChainField::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.

Reimplemented in HouseChainField, and IndustryChainField.

Definition at line 2307 of file industry_gui.cpp.

References _current_text_dir, ChainField::cargo_line, ChainField::cargo_space, ChainField::cargo_stub, Rect::CentreToHeight(), Rect::Contains(), ChainField::GetConnectionHeight(), IsValidCargoType(), ChainField::max_cargoes, Point, TD_RTL, Rect::Translate(), Rect::WithHeight(), and Rect::WithX().

Referenced by HouseChainField::ClickedAt(), and IndustryChainField::ClickedAt().

◆ Draw()

◆ GetAccepted()

virtual CargoTypes AcceptsProducesChainField::GetAccepted ( )
pure virtual

Connected the cargo types accepted by this field.

Returns
The accepted cargo types.

Implemented in HouseChainField, and IndustryChainField.

Referenced by ChainRow::ConnectAcceptedCargo().

◆ GetProduced()

virtual CargoTypes AcceptsProducesChainField::GetProduced ( )
pure virtual

Connected the cargo types produced by this field.

Returns
The produced cargo types.

Implemented in HouseChainField, and IndustryChainField.

Referenced by ChainRow::ConnectProducedCargo().

Field Documentation

◆ other_accepted

std::array<CargoType, ChainField::MAX_CARGOES> AcceptsProducesChainField::other_accepted

Cargoes accepted but not used in this figure.

Definition at line 2263 of file industry_gui.cpp.

Referenced by ChainRow::ConnectAcceptedCargo().

◆ other_produced

std::array<CargoType, ChainField::MAX_CARGOES> AcceptsProducesChainField::other_produced

Cargoes produced but not used in this figure.

Definition at line 2262 of file industry_gui.cpp.

Referenced by ChainRow::ConnectProducedCargo().


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