UDreamTileView
A tile view whose hierarchy is code, not an asset: a list whose rows are laid out across as well
Inherits from UDreamListViewBase.
Declared in Public/Controls/DreamTileView.h.
A tile view whose hierarchy is code, not an asset: a list whose rows are laid out across as well as down.
UMG's TileView derives from its ListView and adds an entry WIDTH; this is the same relationship, for the same reason. Everything that makes a list -- the viewport, the bar, the scrolled column, the row template, the pool, the selection, the recycling threshold -- is UDreamListViewBase's and is not restated here. What a tile view adds is one question answered differently: how many rows sit side by side.
THE COLUMN COUNT IS MEASURED, NOT AUTHORED
UMG's tile view fits as many entries across as the width allows and re-flows when it changes, and so does this one: ResolveColumnCount divides the viewport by the tile pitch. An authored count would be a second number that has to agree with the width, and the first resize would end that agreement -- the same equation-in-two-places the row placement was rewritten to remove.
A floor of one, always: a viewport narrower than a tile shows one tile per line and clips it, which is visible and recoverable, where zero columns is a division by zero and a blank control.
WHAT A TILE'S SIZE IS
Its height is FDreamListStyle::RowHeight -- the SAME field a list's row height comes from, because it is the same measurement -- and its width is FDreamTileViewStyle::TileWidth. There is no aspect lock and no "square" flag: two numbers already say every shape those flags could, and a lock would make one of the two unreadable in the panel.
See UDreamListViewBase for the rest, and UDreamListView for the flat case.
Properties
| Name | Type | Category | In the details panel | From Blueprint | Description |
|---|---|---|---|---|---|
Style | FDreamTileViewStyle | Tile View | yes | GetStyle / SetStyle | This instance's own look. The project sheet wins while StyleSource says so AND a sheet actually exists; with no sheet in the project this IS the look in effect. |
TileAlignment | EDreamTileAlignment | Tile View | yes | GetTileAlignment / SetTileAlignment | How a line's tiles are distributed across the width -- UMG's TileAlignment. |
bWrapHorizontalNavigation | bool | Tile View | yes | GetWrapHorizontalNavigation / SetWrapHorizontalNavigation | Whether stepping off the end of a line lands on the next one -- UMG's bWrapHorizontalNavigation. |
Functions
| Function | Kind | Description |
|---|---|---|
int32 GetColumnCount() | pure | How many tiles fit across the viewport right now: the measured answer the layout is using. |
float GetEntryHeight() | pure | A tile's height -- UMG's EntryHeight, which is FDreamListStyle::RowHeight here because it is the same measurement a list's row height is. One tile, one size, and the style holds it. |
float GetEntryWidth() | pure | A tile's width -- UMG's EntryWidth, which is FDreamTileViewStyle::TileWidth. |
int32 GetNavigationTarget(int32 InDisplayIndex, EDreamUINavigationDirection InDirection) | pure | The display index one step in a direction from InDisplayIndex, or INDEX_NONE for "off the grid". |
int32 GetRowLineCount() | pure | How many LINES of tiles the source makes at the current column count. |
FDreamTileViewStyle GetStyle() | pure | By value, not by reference: a UFUNCTION return has to be a value, and a style is a small struct. |
EDreamTileAlignment GetTileAlignment() | pure | Get Tile Alignment |
bool GetWrapHorizontalNavigation() | pure | Get Wrap Horizontal Navigation |
void SetEntryHeight(float InHeight) | callable | Set Entry Height |
void SetEntryWidth(float InWidth) | callable | Changes how many tiles fit across, so it re-flows rather than repaints. |
void SetStyle(FDreamTileViewStyle InStyle) | callable | Replace the whole look and re-push it. A tile's size is style, so this rebuilds the tiles. |
void SetTileAlignment(EDreamTileAlignment InAlignment) | callable | Changes where every tile sits without changing how many fit, so it re-places rather than re-flows. |
void SetWrapHorizontalNavigation(bool bInWrap) | callable | Set Wrap Horizontal Navigation |
Compared with UMG
Every Blueprint-facing member of the UMG class, and where it went. adopt: same name, same meaning. map: here under another name or on another type. reject: deliberately absent, with the reason.
| UMG | Member | Status | Here | Note |
|---|---|---|---|---|
UTileView | SetEntryHeight | adopt | SetEntryHeight | Writes FDreamListStyle::RowHeight and switches StyleSource to Inline, so the next style push does not throw the number away. |
UTileView | SetEntryWidth | adopt | SetEntryWidth | Writes FDreamTileViewStyle::TileWidth. A different width is a different column count, so it re-flows rather than repaints. |
UTileView | GetEntryHeight | adopt | GetEntryHeight | Off the RESOLVED style, so a tile view wearing the project sheet answers with the size it is actually drawn at. |
UTileView | GetEntryWidth | adopt | GetEntryWidth | Off the resolved style, as GetEntryHeight is. |
UTileView | EntryHeight | map | FDreamListStyle::RowHeight | The SAME field a list's row height comes from, because it is the same measurement. One tile, one size, and the style holds it -- a second field on the control would be the same number written twice. |
UTileView | EntryWidth | map | FDreamTileViewStyle::TileWidth | The one thing a tile adds to a row. No aspect lock and no square flag: two numbers already say every shape those would, and a lock makes one of the two unreadable in the panel. |
UTileView | TileAlignment | adopt | TileAlignment | EDreamTileAlignment, UMG's seven answers. LeftAligned by default, not UMG's EvenlyDistributed: it is what every tile view here has drawn, and a grid that re-spaced itself on upgrade would be a layout change nobody asked for. All seven are one function, ResolveLineLayout, which returns the line's start, its tile size and its pitch TOGETHER -- they are three views of the same leftover space, and answering them separately is how two modes end up disagreeing about it. EvenlySize sizes by the COLUMN count so every line matches; Fill sizes by THIS line's count so a short last line stretches. That is the only difference between them. |
UTileView | bWrapHorizontalNavigation | adopt | bWrapHorizontalNavigation | Answered by INDEX in UDreamTileView::GetNavigationTarget, not by geometry: off the end of a line is the first tile of the next, and the tile it lands on is at the OPPOSITE edge of the control -- exactly the step a nearest-rect navigator cannot make. GetNavigationTarget is what a navigation press on a tile steps by, so the switch reaches the player. Off by default, as UMG's is: a press off the end of a line then leaves the tile view. |
UTileView | ScrollbarDisabledVisibility | map | ScrollBarVisibility | AutoHide already means 'gone while everything fits', which is the state UMG's disabled visibility describes. A second enum for the disabled case would be a second answer. |
UTileView | bEntrySizeIncludesEntrySpacing | reject | A switch over whether the authored size is the tile or the tile plus its gap. Here they are two fields that are never added into one: TileWidth is the tile and TileSpacing is the gap beside it, so there is no ambiguity for a flag to resolve. |