Pages in Documentation

../images/architecture/2024/custom/thumbs/04.jpg
Customize
../images/architecture/2024/kitchen/thumbs/01.jpg
Overview
../images/architecture/2023/spline_versions/thumbs/02.jpg
Spl. T. Versions
../images/architecture/2023/spline_placement/thumbs/02.jpg
Placement
../images/architecture/2023/spline_mesh/thumbs/02.jpg
Mesh Def.
../images/architecture/2023/spline_segment/thumbs/03.jpg
Segments
../images/architecture/2023/books/thumbs/01.jpg
Books V2
../images/architecture/2023/ui3_history/thumbs/01.jpg
UI3 Versions
../images/architecture/2023/ui3-custom/thumbs/01.jpg
Features /Preview
../images/architecture/2023/ui32/thumbs/01.jpg
UI3 Overview
../images/architecture/2023/ui3_faq/thumbs/01.jpg
UI3 Bugs
../images/architecture/2023/ui3_data/thumbs/02.jpg
3.2 UI Settings
../images/architecture/2023/ui3_design/thumbs/01.jpg
3.2 UI Design
../images/architecture/2022/splinesV3/thumbs/01.jpg
3 Spline Tools
../images/architecture/2022/doorsfaq/thumbs/01.jpg
Doors FAQ
../images/architecture/2022/doorsv2/thumbs/01.jpg
Doors V2 UE5
../images/architecture/2022/steps/thumbs/12.jpg
Step by Step
../images/architecture/2022/kitchenfaq/thumbs/01.jpg
2 Tips & FAQ
../images/architecture/2022/kitchen/thumbs/01.jpg
1 Reference
../images/architecture/2021/ui3-game/thumbs/07.jpg
UI3 Game Modes
../images/architecture/2021/ui3-faq/thumbs/01.jpg
UI3 FAQ
../images/architecture/2020/books/thumbs/01.jpg
Books V1
../images/architecture/2020/doors/thumbs/01.jpg
Doors V1
../images/architecture/2024/kitchenchange/thumbs/02.jpg
Change list
../images/architecture/2021/ui3-bugs/thumbs/02.jpg
3.1 Bugs Fixes
../images/architecture/2020/spline/thumbs/01.jpg
2A Generic BP
../images/architecture/2021/splexamples/thumbs/01.jpg
2B Gen Examples
../images/architecture/2020/railings/thumbs/01.jpg
1 Railings
../images/architecture/2019/guide1/thumbs/01.jpg
UI 1 - Part 1
../images/architecture/2018/03/thumbs/06.jpg
UI 1
../images/architecture/2019/guide2/thumbs/01.jpg
Ui 1 - Part 2
../images/architecture/2019/ui2/thumbs/01.jpg
1 Overview
../images/architecture/2019/ui2features/thumbs/04.jpg
2 UI Features
../images/architecture/2019/ui2start/thumbs/01.jpg
3 Get Started
../images/architecture/2019/ui2info/thumbs/08.jpg
4 Info Map
../images/architecture/2019/ui2act/thumbs/01.jpg
5 BP Actors
../images/architecture/2020/clients/thumbs/01.jpg
6 Manage Clients
../images/architecture/2020/faq/thumbs/03.jpg
7 FAQ
../images/architecture/2019/ui2examples/thumbs/06.jpg
8 Tutorials
../images/architecture/2021/ui3/thumbs/01.jpg
UI3 Overview
../images/architecture/2021/ui3-start/thumbs/02.jpg
UI3 Get Started
../images/architecture/2021/ui3-infomap/thumbs/02.jpg
3.1 Info Map
../images/architecture/2021/ui3-var/thumbs/01.jpg
UI3 Edit Mode
../images/architecture/2021/ui3-actors/thumbs/02.jpg
UI3 Blueprints

Features With Preview

Features With Preview (former Custom Features) can be any of the following features

  • Scenario
  • Design Scheme
  • Variation Group
  • Scene Travel
  • Sequence Player

This section explains how to use them.

Content:

Video Tutorials

Differences between UI3 versions

Use Features With Preview in the UI

Scenarios

Design Schemes and Variation Groups

Sequence Player

Scene Travel

Setting up a Feature With Preview

Setting Up Variation Actors for Groups

Updating Feature Settings

Video Tutorials

Three parts of the Video Tutorials are about the use of the Variation Actor and the UI Features related to it.
  • Part 4 - Design Schemes
  • Part 5 - Variation Groups
  • Part 6 - Object Interaction

This video is part 4. Click on the link below to watch the entire playlist.

Video Tutorial Play List

Differences between UI3 versions

The UI3 had only one instance per feature type available in the earlier versions. One Design Scheme, one Scenario, and so on. This sometimes wasn't enough. You couldn't change the kitchen layout and the lighting with only one scenario. Or travel to another unit in the current building, and also to other buildings. It was either or.

So I added 5 custom features that could be used in addition to the 4 single feature types.

The next logical step was to make everything a custom feature with preview. This happened September 2023.

It causes some problems for projects that are updated from earlier versions.

  • The original feature panels, like the single Design Scheme were empty. You have to enter the settings into the Features with Preview array instead.
  • An ID was needed to identify the features in the interface. That couldn't be done with the old system. All the panels have to be recreated.

You can get the UI to do the update for you. Read how at the very last section of this page.

image

Use Features With Preview in the UI

Use the Feature With Preview type if you want to add a Design Scheme, Variation Group, Scenario, Scene Travel, or Sequence Player in the Main Menu Layout

Then create an element in the Features with Preview array. Set the Custom Feature to the type of feature you want to use, like Design Scheme. Add the name and the options to that array element as well. Read further down how.

Then go back to the Main Menu Layout and enter the array index of the new feature you just created as the Feature ID in the panel array.

image

Scenarios

Scenarios are sub levels that can hold any assets. They can provide two different furniture or kitchen layouts as demonstrated in the demo scene.

They can also hold the entire lighting information for the scene. You could have one with night light and one with daylight set up. In this case they are Lighting Scenario and need to be marked as such in level browser (the light icon enabled).

Lighting Scenarios Documentation

image

Design Schemes and Variation Groups

Design Schemes will change all Variation Actors to the ID that is set as the option for this choice. They need to have Use With Design Schemes ticked, which is the on by default.
In previous versions the Design Scheme's option array id was used as the option ID.

A Variation Group is a group of Variation Actors that can be changed at once.

image

Sequence Player

The Sequence Player can run animations that are set up using Unreal Sequences. They are movies taken in real time. All current changes will appear in them.

Unreal Sequencer Documentation

image

Scene Travel

This allows you to load another scene (or world). Which means you are loading another persistent level. This level needs its own UI and Info Map. Use this for multi unit projects or multi houses developments. The level needs to be in the same project. You can't load a level in a different project.

image

Setting up a Feature With Preview

Add an array element to the Features with Preview array to create a new feature. You can add, copy, delete, or move them like with any other array.

> Features With Preview
> Features with Preview Add an array element for each feature.
> Index [0] Feature ID 0
> Index [1] Feature ID 1
Custom Feature Choose the type of feature
  • Scenario: Switches sub levels for layout or lighting
  • Design Scheme: Switches ALL variation actors to the option ID
  • Variation Group: Switches selected variation actors
  • Scene Travel: loads a new scene persistent level
  • Sequence Player: plays sequences (pre set up animations)

Feature Header A header name for the UI
Default Option the ID of the option loaded at app start. Note that the defaults will be set in descending order. First feature comes first. Later features have higher priority and will overwrite previous defaults.

image
> Options Add an array element for each option.
> Index [0] first option
Preview A preview image with the size ratio set in the UI Design section. Size can be defined in the UI settings
Name The name displayed in the UI below the preview image
Option
  • Scenario or Scene Travel: the exact name of the level
  • Design Scheme or Variation Groups: the option ID
  • Sequence Player: the ID of the sequence set up in the Sequences Array below
> Sequences Array Add an array element for each sequence you want to use.
> Index [0] first sequence ID 0 - use the ID as the OPTION for the sequence player feature
> Index [1] sequence ID 1

image

Setting Up Variation Actors for Groups

Variation Groups, unlike a Design Scheme, can change groups of Variation Actors. The seating/couch area in the demo project is an example for this.

The Variation Actors will only change if they have an entry for the group's Feature ID. If it has it will set the Variation Actor to the Variation ID that is set for the Option ID it received.

> Variation Settings
> Variation Groups Add an array element here per Variation Group
> Index [0] Group ID
Feature ID Enter the ID of the Variation Group in the Feature with Preview array
> Variation ID array of options
Index [0] Variation that should be set for Option [0] of the Variation Group. In this example Options and Variation IDs are the same. So choosing Option 0 will switch the actor to Variation ID 0.
Variation and Option ID don't have to be the same.
Index [1] Variation that should be set for Option [1] of the Variation Group
Index [2] Variation that should be set for Option [2] of the Variation Group

image

Updating Feature Settings

You can update data from the previous versions to the new system. You may have to adjust the data afterwards. Already set new data will not be changed unless Force is clicked.

UI Panels Design

(Force) Update From Old Data

This will copy the layout from Content (Old) to Feature Panels and set IDs as well.

Features With Preview Images

(Force) Create Array from OLD Old Data

This will copy the data from the old single Scenarios, Design Schemes, Scene Travels, and Sequence Player and append any existing Custom Features to the Features with Preview array.

image
Top of page