Reference
UI widgets
The widget names the generated HUD and its building blocks bind to, and the properties of every BAKR button.
The generated Widget Blueprints find their parts by name. Keep these names and types, with Is Variable on. A required widget that is missing causes a compile error. An optional one can be deleted, and its behavior disappears with it.
WBP_BAKRHUD (parent: BAKRDesignerHUDWidget)
| Name | Type | Required | Role |
|---|---|---|---|
ConfiguratorPanel | Widget | Yes | The panel that hides and shows |
Pages | Widget Switcher | Yes | Holds the page scroll boxes as direct children |
MaterialOptions | Scroll Box | Yes | Materials page |
StyleOptions | Scroll Box | Yes | Styles |
VariantOptions | Scroll Box | Yes | Variants page |
MotionOptions | Scroll Box | Yes | Motion page |
CameraOptions | Panel | Yes | Camera bar. Keep it outside ConfiguratorPanel. |
SummaryOptions | Scroll Box | No | Summary page |
SummaryButton | Button | No | Opens the summary |
CustomizationCount | Text | No | Number of changes from the defaults |
PageTitle | Text | No | Title of the open page |
MaterialsTab, StylesTab, VariantsTab, MotionTab | Button | No | Tabs. A tab hides itself when its page is empty. |
MaterialsTabUnderline, VariantsTabUnderline, MotionTabUnderline | Widget | No | Active tab marker |
ResetButton | Button | No | Back to defaults |
HidePanelButton | Button | No | Hides the panel |
ShowPanelButton | Button | No | Shows it again. Keep it outside ConfiguratorPanel. |
ProductSwitcher | Button | No | Opens the product menu |
ProductName | Text | No | Current product's name |
ProductChevron | Widget | No | Menu arrow |
ProductMenu | Panel | No | Holds the product rows |
The tab, reset, panel and summary buttons above are matched by name in layouts generated before the building blocks. A current HUD uses BAKR Buttons for them instead, which need no particular name.
Class Defaults → BAKR → Designer holds the classes used for repeated parts: Option Widget Class, Section Widget Class, Summary Row Widget Class and Product Entry Widget Class. Panel Width (340) is used for touch exclusion and framing.
BAKR Button, BAKR Primary Button, BAKR Tab
WBP_BAKRButton, WBP_BAKRPrimaryButton and WBP_BAKRTab. They work anywhere inside the HUD.
| Name | Type | Required | Role |
|---|---|---|---|
Button | Button | Yes | The click target. Its Designer style is the normal look. |
ButtonLabel | Text | No | Shows Label |
SelectionIndicator | Widget | No | Shown while the action is on, such as a tab's underline |
| Property | Meaning |
|---|---|
| Action | Reset, Show Panel, Hide Panel, Toggle Panel, Summary, Materials Page, Variants Page, Motion Page, Product Menu or None. See Customize the UI. |
| Label | The caption. |
| Collapse When Unavailable | On hides the button when its action has nothing to do. Off keeps it in place. |
| Selected Style / Selected Label Color | Class Defaults → Style. The look while the action is on. |
Readable: Selected, Available. Press clicks it, Get HUD returns its HUD, State Changed fires after Selected or Available changes, On Clicked after it has done its job.
BAKR Option, Sequence and Camera Button
WBP_BAKROptionButton, WBP_BAKRSequenceButton and WBP_BAKRCameraButton, from Tools → BAKR → Create UI building blocks. They need no HUD. They use the same Button, ButtonLabel and SelectionIndicator names as a BAKR Button; an option button also tints an optional SwatchImage (Image).
| Block | Properties (exposed on spawn) |
|---|---|
| Option Button | Kind (Material or Variant), Zone, Option ID, Show Swatch |
| Sequence Button | Sequence ID, Action (Play, Reverse, Pause, Stop) |
| Camera Button | Camera ID |
All three also have Label, Collapse When Unavailable (off by default: an unavailable button stays in place, disabled), Selected Style and Selected Label Color. An empty Label shows the catalog's name.
WBP_BAKRSummaryRow (parent: BAKR Summary Row)
| Name | Type | Required | Role |
|---|---|---|---|
ZoneText | Text | No | Zone name |
ValueText | Text | No | Chosen option |
StatusBadge | Border | No | Default/Customized badge |
StatusText | Text | No | Badge text |
SwatchImage | Image | No | Chosen material's swatch |
Badge colors and the Default / Customized wording are in Class Defaults → Style. Row Changed fires after the row is filled, with Zone, Value, Changed, Has Swatch and Swatch readable.
WBP_BAKRSection (parent: BAKRSectionWidget)
| Name | Type | Required | Role |
|---|---|---|---|
SectionLabel | Text | Yes | Zone name |
SectionOptions | Panel | Yes | Holds the option buttons |
SectionCategories | Panel | No | Category picker row |
SectionButton | Button | No | Heading click: expand or collapse |
SectionBody | Widget | No | The part that collapses |
SectionChevron / SectionChevronButton | Widget / Button | No | Expand arrow |
SectionSwatch | Image | No | Current choice's color |
SectionCameraButton | Button | No | Fly to the zone's linked camera. A sibling of SectionButton, not inside it. |
SectionCameraIcon | Border | No | Icon inside the camera button |
WBP_BAKROption (parent: BAKROptionWidget)
| Name | Type | Required | Role |
|---|---|---|---|
OptionButton | Button | Yes | The click target |
OptionLabel | Text | Yes | Option name |
SwatchImage | Image | No | Material swatch color |
SelectionIndicator | Widget | No | Shown on the selected option |
OptionSize | Size Box | No | Button size |
Readable on the option: Label, Selected, Available, Zone, Option Id. OptionButton's Designer style is the unselected look and Selected Style (Class Defaults → Style) the current choice, so a square option stays square. Implement Option Changed to restyle beyond that after each update. An unavailable option is disabled with a tooltip naming the conflict.
WBP_BAKRProductEntry (parent: BAKRProductEntryWidget)
| Name | Type | Required | Role |
|---|---|---|---|
ProductButton | Button | Yes | Switches to the product |
ProductLabel | Text | Yes | Product name |
SelectionIndicator | Widget | No | Marks the active product |
Built-in behavior
- Opening a section or switching category scrolls it into view. A section taller than the panel starts at its heading.
- Summary cards show the zone, the chosen option, its swatch and a Default or Customized badge.
- Scroll positions survive refreshes.
- Arriving at a camera with a Linked zone opens that zone's section.