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 Frequently Asked Questions

FAQ, Tips and tricks, or answers for frequent questions are here. Known bugs are on the next page.

Content:

No option for 5.3 and 5.4 versions

Image Ghosting

Player Facing the Wrong Way At Start

I cannot select an object in edit mode

Looking Through Windows Looks Wrong.

VR Tablet Is Blurry

Using VR, Touch or Gamepads

Pixel Streaming

Packaging Fails

Packaging Tips

Using GPU Lightmass

Main Menu Compile Error

No option for 5.3 and 5.4 versions

There may only be options to create new projects in versions 5.0 to 5.2. This seems to be a glitch in the Epic Games Launcher.

Remove Local Content and then close and reopen the Games Launcher.

This should fix the issue, and all options should now be in the list

All Unreal 5 versions of ArchViz UI3 are more or less the same at the moment except a few minor fixes for Unreal 5.3 and later.

image

Image Ghosting

Problem:

The image has a ghosting translucent double in certain angles. Seems to be performance related.

Cause:

This is most likely caused by bad project settings. The project has travelled through version updates and at one point some project settings were added that is causing this issue.

Solution:

Rename the Config folder to Config.old then open the project.

Download the config folder from the link below and extract it to your project. This should fix the issue. Any special project settings will be lost and have to be redone.

Updated Config Folder for 5.3 and later (3 kB)

image

Player Facing the Wrong Way At Start

The player may start facing random rotations when the App starts. You can fix this by adding a BP_UI3Location near the start point and then use the name of that start point as the Start Location Name in the Info Map in the Project Settings Section.

image

I cannot select an object in edit mode

This has been fixed in the latest update.

Problem: You cannot select an object in edit mode. The name changes when you hover over the object, but nothing happens if you select it.

Solution: Open the project settings and search for Touch in the search bar on top of the window. Untick the tick box where it says: Use Mouse for Touch.

If this doesn't help then try to update the UI3 or check if a large collision is in front of the objects.

image

Looking Through Windows Looks Wrong.

This can happen in any of the Unreal 5 versions. Lumen is creating ambient occlusion and shadows. But it doesn't really care about translucency. The demo project uses ray traced translucency for this reason. This improves the Reflections on the glass panes as well.

Part of translucency is Refraction. Turn it off to fix overly dark shadows behind glass. As seen in the image. You can also try to tweak refraction in the glass material. (There might be other places to look for it, like the light sources, or the project and world settings).

This topic has many aspects and it is constantly changing as well. I can only direct you to Google to find out what works best for you.

image

VR Tablet Is Blurry

Sorry I'm aware of it. I submitted an update with an example level to show how to set the UI up for VR.
  • The update fixes the interface not responding
  • Set the default aperture to 32 or it will be blurry because the tablet is out of focus. (Settings - Cinematic Camera)
  • use colour scheme id 3 as a start
  • increase icon and text sizes

Cinematic Camera Settings

image

Using VR, Touch or Gamepads

You need to set the Game Mode in the World Settings of your scene. The World settings are part of the 'persistent' level. If You only have one level, then this level is the persistent level.

UI3 can be used with

  • Mouse and Keyboard controls on a PC
  • A gamepad on a PC
  • Touch controls with or without Pixel Streaming
  • VR projects with VIVE or Oculus Rift controllers or a gamepad.

Read on how to use Game Modes for these different uses.

UI3 Game Modes

image

Pixel Streaming

With touch screen controls available now pixel streaming is also possible to tablets and other devices that don't have the power to render the scene. You can run the app in any modern web browser this way.

Follow the steps in the link below to enable pixel streaming for your project. It's easy to do locally in your own network. Some additional steps are needed to stream over the internet or alternatively you can use a service like https://www.furioos.com/

Getting Started with Pixel Streaming.

image

Packaging Fails

Sometimes Unreal didn't install some additional software needed. Check that you have the software when the packaging fails early on:

  • Windows SDK
  • Visual Studio (free community version)
  • Net framework (if everything else doesn't help)

Check the output log if the packaging fails later on. Scroll down to the very end and then look for any red messages above, like a missing structure here:

[2023.06.08...]LogProperty: Error: FStructProperty::Serialize.../UI/Widgets/UI3_CustomButton.UI3_CustomBu tton_C: Color Set Used'. Unknown structure.

Scroll down for a few more solutions for failed packaging.

Unreal Documentation

image

Packaging Tips

Packaging will create an app that can be run by users that do not have Unreal installed. You find it in the File menu (Unreal 4) or above the viewport (Unreal 5).

First make a few changes to the Project Settings

  • Set the Default Game Map In the Maps and Modes section. This needs to be the main (persistent) level of your scene.
  • Add the levels that need to be cooked in the Packaging - Advanced - List of Maps to include... array. You don't need to add any sub levels that are loaded from your main levels to the list. But you need to add any other levels if the user can travel to them.
  • Add your movie directory there as well. I put them in both arrays Additional Non-Asset Directories ... . It's probably not necessary that way.

NOTE: Leaving the list of maps empty can increase your package size significantly. In that case everything in the project will be packaged.

image

Using GPU Lightmass

Lumen is the best way to light your scene in Unreal 5.

GPU Lightmass can be used to bake lighting in your scene if you want to use raytracing instead of Lumen. Follow all the steps suggested in the documentation (link below) to use it in your project. UI3 will not interfere with lighting in the scene. Scenarios are working with GPU LM.

Dynamic objects (mesh variations) need some direct light to look decent (not black). This can be the skylight. Reflection actors need to be rebuild manually after each GPU Lightmass build. Black variation actors can be caused by missing reflection actors. Place one with low radius next to the black asset and rebuild lighting and reflections.

Unreal GPU Lightmass Documentation

image

Main Menu Compile Error

Symptoms: You'll get a few load errors. The game won't 'Play' in editor and give you a message that there are blueprint errors in the 'Main Menu'.

Solution: This is caused by the Sun Position Calculator or the OpenXR plugin not being enabled. Please enable them even if you do not intend to use them. You have to restart the editor for the Plug-In to be enabled.

Do not save the Main Menu Widget before restarting. It should be fine after the restart. If you did save then re-migrate the MainMenu widget from the UI3 Demo Project and make sure to override when asked.

image
The OpenXR plugin was enabled by default in engine versions prior to 5.3. I have enabled this in an update. The node Enable HMD is part of this plugin which starts the VR headset in the SDotUI3_GamemodeVR from the Begin Play node.

Please replace the Enable HMD with the appropriate node from the plugin that is required for your headset if necessary.

image
Top of page