ArchViz UI3 Documentation 2024-09

Table of Content
Table Of Content
../images/architecture/0033/quick/thumbs/01.jpg
Quick Guide
../images/architecture/0033/videos/thumbs/01.jpg
Video Guides
../images/architecture/0033/start/thumbs/02.jpg
Getting Started
../images/architecture/0033/design/thumbs/01t.jpg
UI Settings
../images/architecture/0033/layout/thumbs/02.jpg
UI Layout
../images/architecture/0033/features/thumbs/08.jpg
Widget Panels
../images/architecture/0033/preview/thumbs/01.jpg
F. w. Preview
../images/architecture/0033/designer/thumbs/02.jpg
Designer
../images/architecture/0033/variation/thumbs/01.jpg
Variation Actor
../images/architecture/0033/cost/thumbs/02.jpg
Cost Tracking
../images/architecture/0033/data/thumbs/04.jpg
Data Tables
../images/architecture/0033/csv_export/thumbs/03.jpg
Google Data Sheets
../images/architecture/0033/settings/thumbs/16d.jpg
Scene Settings
../images/architecture/0033/other/thumbs/02.jpg
Blueprints
../images/architecture/0033/game/thumbs/07.jpg
Gamemode
../images/architecture/0033/vr/thumbs/03.jpg
VR projects
../images/architecture/0033/connect/thumbs/02.jpg
Connect BP
../images/architecture/0033/faq/thumbs/08.jpg
FAQ + TIPS
../images/architecture/0033/bugs/thumbs/01m.jpg
Fix Known Bugs
../images/architecture/0033/history/thumbs/01.jpg
Version History

Google Cloud And Sheets

Using Google Cloud and Google Sheets to store and receive data for multi-unit projects.

Part 1 Google Cloud

This is a modification of the UI3 and does not come with it by default. Changes need to be made to widgets and blueprints and third party plug- ins are required.

Content:

Introduction

Google Service Account

Connecting to UI3

Google Drive

Google Sheets

Unit Data

User Costs Sheet

Introduction

There may not be direct access to the computer that hosts the walkthrough app. It may be on a remote server and Pixel Stream onto a mobile device.

This part shows how to set up Google Sheets to receive and send data to the walkthrough app from a web browser.

The Runtime Datatable plug-in is needed to connect the Unreal walkthrough app to the Google Cloud Service. Follow the link below to get it from FAB.

Runtime Datatable on FAB

image

Google Service Account

A Google Service Account is needed to access the Google Cloud through the API. It's free for a few months and then very reasonable priced. Only a minimal storage space is required for the UI3 documents.

The Runtime Datatable plugin's documentation has info about creating an account.

A project needs to be created in the cloud and a permission key needs to be set up in the IAM section.

Runtime DataTable Plugin Documentation

image

Connecting to UI3

Access Key Data

The key comes as a JSON file and can be opened with Notepad and other common applications. It should look like seen in the image.

Copy Paste the credentials into the DT_GoogleLinks Data Table (or any other assigned).

  • Private Key is the long cryptic string.
  • Client Email is the google admin email address shown below the key. It's not your 'normal' google account email address.

The credentials can be used for multiple Unreal projects.

Sharing Links

Links for the Users, Servers, Units, and Unit Types sheets are also entered into this Data Table. It can then be assigned to each Info Map of the unit type persistent levels. Changes to the Data Table will spread to all scenes.

image

Google Drive

Create a folder for the project's data sheets.

The folder needs to be shared. It can be restricted to certain users as every other Google Sheet. Best to start by allowing for Everyone with the link to have rights to Edit it. Restrictions can be placed later, when it's sure that everything works.

All sheets in the folder inherit the rights of the folder.

image
The following sheets can be copied into the folder and then renamed for better navigation. The files are attached below.
  • HS Servers
  • HS Users
  • HS Units
  • HS Unit Types
  • HS Costs

HS Costs is specific to the client (user) that is using the walkthrough. There needs to be one Cost file per user.

Google Default Sheets

image

Google Sheets

HS Server

The server file contains the server id and the currently assigned user id. The app will read the user id for its server id when it starts. Most of the times there will only be one server in the list.

Add an entry for running multiple servers at the same time. Then set the relevant user id before starting the app on that server.

image

HS Users

The app will always start with the overview map showing the outside of the building. The client selects a unit to visit. The unit id will be entered into the user's row in this sheet before opening the scene for the unit type.

  • Row Name User ID to be entered in the Servers sheet
  • User Name The real name of the user
  • Unit Will be written by the app. The last unit visited by the user

image
  • Costs GID Google ID of the Costs sheet tab
  • Features GID Google ID of the Features tab
  • Selections GIDGoogle ID of the Selections tab
  • Costs Sheet Shared link for the user's Costs Sheet.

The Costs Sheet link is the link being copied when you right click share the Google Sheet on Google Drive.

The GID or Google ID can be found in the URL when selecting the sheet tab on the bottom.

image

Unit Data

There are 2 sheets containing the unit data.

HS Units

Contains specific data for each unit.

  • Row Name The Unit ID
  • Unit Type Name The ID of the unit type
  • Floor The building floor, where '0' is the ground floor
  • Unit / Lot Size Sizes for this unit, overwrite type sizes
  • Unit Cost The cost of this unit, overwrites type cost
  • Availability ID of the availability array located in the Info Map

image

HS Unit Types

The details for the type of units. There can be more than one unit of each type in the building.

  • Row Name The type ID or Unit Type Name
  • Type Name User friendly name
  • Bedroom, Bathroom, Parking typical features
  • Additional Features any additional text to be displayed
  • Size, Price can be overwritten per unit

image

User Costs Sheet

This sheet document has 3 sheets. There are tabs at the bottom to navigate between them.

The sheet will be completely overwritten when the user exports the selections made to the scene. So no need to enter anything manual into the sheet. It just needs to exist.

Costs

This list is the same that the UI shows to the user in the Costs widget. It is converted to a table in the image.

image

Features

The selected features. This can be design schemes or layout scenarios.

image

Selections

Contains the data for all selectable objects in the scene. This is what the Cost is based on with more detail to it.

image
Top of page