ArchViz UI3 Documentation 2024-09

Table of Content
Table Of Content
../images/architecture/0033/quick/thumbs/01.jpg
UI3 Quick Guide
../images/architecture/0033/start/thumbs/02.jpg
UI3 Get Started
../images/architecture/0033/design/thumbs/01t.jpg
UI3 Design
../images/architecture/0033/layout/thumbs/02.jpg
UI3 Layout Design
../images/architecture/0033/features/thumbs/08.jpg
UI3 Features
../images/architecture/0033/preview/thumbs/01.jpg
UI3 Preview Ft.
../images/architecture/0033/designer/thumbs/02.jpg
UI3 Designer
../images/architecture/0033/variation/thumbs/01.jpg
UI3 Variations
../images/architecture/0033/cost/thumbs/02.jpg
UI3 Cost
../images/architecture/0033/settings/thumbs/16d.jpg
UI3 Scene Settings
../images/architecture/0033/other/thumbs/02.jpg
UI3 Other BPs
../images/architecture/0033/game/thumbs/07.jpg
UI3 Input&Mode
../images/architecture/0033/vr/thumbs/03.jpg
UI3 VR projects
../images/architecture/0033/connect/thumbs/02.jpg
UI3 Connect
../images/architecture/0033/faq/thumbs/08.jpg
UI3 FAQ + TIPS
../images/architecture/0033/bugs/thumbs/01m.jpg
UI3 Fix Bugs
../images/architecture/0033/history/thumbs/01.jpg
UI3 Vers History

UI3 Quick Guide

Quick Guide for the Arch Viz UI3 User Interface available on FAB and the Unreal Marketplace.

Content:

Installation

Content Location

Plugins

Game Mode

General Settings

Interface Panel Layout

Scene Settings

Object Interaction

Packaging

Installation

The ArchViz UI3 project will appear in the Vault in the Epic Games Launcher after your purchase.

Use the yellow button to create the demo project. Choose the appropriate Unreal Engine version.

The latest project version will be downloaded. This can take a while.

image

Content Location

The project files will be installed in the Content folder of the project. MyProject / Content / ArchVizUI_V3.

You have to options to migrate the UI3 to your own project:

  1. Migrate the entire ArchVizUI_V3 folder. This includes all demo levels and all assets used in them. It's about 2 GB.
  2. Migrate only the UI folder. This contains all blueprints, widgets, icons and everything you need for the user interface. It excludes the demo levels and assets in it. It's about 80 MB

The yellow marked blueprints in the UI / Blueprints folder are the ones that will be placed in the scene for the interface to function.

image

Plugins

The following plugins should be installed in your project even if you don't intend to use them:
  • Enhanced Input - controls input actions from keyboard or gamepad
  • Sun Position Calculator - Accurate sun positioning for geo location
  • OpenXR - standard used for VR headsets. - You may need a different one.

Packaging will fail if these plugins are missing.

image

Game Mode

Set the Game Mode Override in the World Settings. Choose one of the four SDot UI3 Game Modes from the list.

image

General Settings

The blueprint BP_SDOTUI3_InfoMap is required in your scene. Place it in a non-streaming level.

> General Project Settings
Update Blueprint Tick this when the floorplan isn't scaled correctly.
Intended UI Use (Optional)
[ Info ] Applied Preset
Choose the Intended UI Use (Optional)  from the list. This will apply some settings to the UI. The Applied Preset will then be shown in the next row.
> Streaming Levels It's recommended to split the scene content into sub levels. Add the Streaming Levels to the array. Do not add scenario levels or levels for a different scene you want to load from within the UI to this list.
Use Target/Mouse Move Target or Mouse Move will move the player character with a click to the spot on the floor that is marked with the cross.

image
Floorplan drawings can be added in the Floorplan section.

Floorplan
Floorplan Scale Manually scale the floorplan here. This makes sure that the XY ratio stays intact.
> Floors or Units Use the (+) icon to add floors or units.
Floorplan Drawings have to be black on white background
Height Offset start with the lowest floor and add the height offset from that level to each additional floor above.

Use Transform to align the location and the rotation.

Transform
Location Move the floorplan roughly to the correct position
Rotation Use the Z rotation to align the floorplan to the building
Scale Do not change the scale

image

Interface Panel Layout

The UI Panel Layout is set with the Main Menu Layout array. Each Index is a main menu button appearing from left to right on top of the screen.

Feature Panels will appear below when you click a main menu button. You can fit 3-4 smaller panels in one button. Some features, like the floorplan, need their own panel. There is no "panel scrolling", only items within the panels can scroll.

> Panels Design
> Main Menu Layout One main menu button equals one array index
Menu Icon Menu icons are in UI / Tex / Icons
> Feature Panels Feature Panels appear vertically stacked below the button
Feature Type Choose from the list
Feature ID Some features that can be placed in multiple version require an ID

image

Scene Settings

Scene Settings alter the way the application is played: Quality, Movement, Camera.

You may want to reduce quality to improve performance for example.

This is set in the Settings - Game section. Every section has an array with values for the sliders. The Default value is loaded when the app starts, regardless of the settings panel being placed in the UI or not.

image

Object Interaction

Objects in the scene can be changed. There are 2 components involved
  • User Interface: Design Schemes, Designer, and Edit Mode allow the user to make a choice.
  • Variation Actor: The link from the UI to the object in the scene where the object is actually modified.

The User Interface offers three widget panels

  • Edit Mode: objects in the scene are selected and then edited
  • Designer: for objects types - all doors or all kitchen cabinets
  • Design Scheme: many objects are changed to a different scheme

image
The blueprint actor BP_SDotUI3_Variations is the link between the interface and the object in the scene. Place one next to the object(s) that should change. Object and Blueprint need to be in the same level.

Variation Settings
Variation Actor Type choose the type for the variation actor from the list
Tag Designer uses a matching tag name to link to variation actors
> Actors connect static mesh actors in the scene with the eye dropper
Variation Details set the name, price, or preview icon per choice
Variation Materials set the materials per material ID and choice.
Variation Meshes set static mesh variations.
Variation Info provide more info about the object (optional)

The Variation actors multiple arrays are all connected by the index. Material choice, Mesh choice, Details, and Info are all set to the same index.

The Designer is able to change materials and mesh variations independently for the same object.

image

Packaging

Run the editor on its own first, not by loading a project. This seems to install any missing "pre-requisite" applications.

Install the free Visual Studio Community version from Microsoft's website. This is required to package a project. There is an Unreal Engine component with it that needs to be selected during install.

Open the Project Settings -> Packaging

Packaging
> Advanced Scroll down to the advanced packaging section
> List of Maps to include in a packaged built Add your persistent levels to the list.
Additional Non-Asset Directories to Package
Additional Non-Asset Directories to Copy
Add the movies directory to the list, if it isn't Content/Movies

Click on Platform to start packaging.

image
Top of page