|
@ -0,0 +1,56 @@
|
|||
---
|
||||
title: Conversion in Azure Remote Rendering asset tool
|
||||
description: Workflow to convert a model in ARRT
|
||||
author: mafranc
|
||||
ms.author: mafranc
|
||||
ms.date: 03/23/2020
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Conversion in Azure Remote Rendering asset tool
|
||||
|
||||
![Conversion panel](media/conversion.png)
|
||||
To access the conversion environment, click on the button on the top toolbar.
|
||||
To convert a file, click on "New". Now the view is split between a conversion list on the left side, and the conversion configuration panel on the right side. Follow these steps to configure your new conversion:
|
||||
|
||||
## Input model selection
|
||||
|
||||
If you click on the button "Select" on the right of the input field, a panel will show the content of your blob storage. To choose the model to convert, first choose the blob container, then select an input model.
|
||||
|
||||
The blob list visualization has two modes:
|
||||
|
||||
* When **show all models** button is selected, all of the models will be shown in a flat list. If a directory is selected, then the list will be filtered with only the models in that directory or subdirectories. The list shows just the valid 3d file input formats (FBX, GLFT, GLB).
|
||||
![Show all models](media/standardbloblist.png)
|
||||
* When **show all models** is not selected then the list will show only the content of the selected directory, with all of its blobs and subdirectories. You can double-click on the folders to navigate into them, like a file explorer, and find your model.
|
||||
![Show only directory](media/directorybloblist.png)
|
||||
|
||||
## Input root directory selection
|
||||
|
||||
The root directory is the one under which the input model and any file referenced by it (for example textures files) will be located.
|
||||
Before starting the conversion, all of the files in the chosen root and its subdirectories will be transferred to the conversion service.
|
||||
|
||||
By default this directory is set to the model directory. Make sure to select a higher-level root if you know that some referenced resource is outside of the model directory.
|
||||
|
||||
## Conversion configuration parameters
|
||||
|
||||
If the input model has been selected, you can visualize and edit all of the parameters for your conversion. See the page [Configure the model conversion](https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/configure-model-conversion) for more information on each parameter.
|
||||
|
||||
The configuration is written to a blob named "ConversionSettings.json" and stored on the input directory.
|
||||
|
||||
## Output directory selection
|
||||
|
||||
At the bottom of the conversion panel you can select the output directory (click on "Select" on the right side of the output field).
|
||||
|
||||
The panel is similar to the input panel, but it will show you just the sub-directories in the current directory, or, if you click on "Show all" button, it will show also all of the other blobs.
|
||||
|
||||
To select a directory you can navigate to it and press "ok", or you can select a sub-directory and press ok.
|
||||
|
||||
Like for the upload panel, you can also select a new directory by clicking on the "Add Sub-Directory" button, and entering the name of a new directory.
|
||||
|
||||
![Directory selection](media/newdiroutput.png)
|
||||
|
||||
## Start conversion
|
||||
|
||||
Once everything is set up correctly, you can press the button "Start Conversion" in the bottom-right corner. The status of the conversion will change to "Converting" and, if successful, to "Completed".
|
||||
|
||||
You can create multiple conversions and run them at the same time. You can also rename them by editing the "Name" field, or delete them from the list when not running.
|
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
title: Azure Remote Rendering asset tool user documentation
|
||||
description: Azure Remote Rendering Asset Tool Documentation for the user
|
||||
author: mafranc
|
||||
ms.author: mafranc
|
||||
ms.date: 03/23/2020
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Azure Remote Rendering asset tool (ARRT) user documentation
|
||||
|
||||
![ARRT material editing view](media/ARRT.png)
|
||||
|
||||
ARRT (Azure Remote Rendering asset tool) is an application using Azure Remote Rendering service (ARR) to upload, visualize, and edit 3D models.
|
||||
|
||||
ARRT can be used by technical artists or contents creators to:
|
||||
|
||||
* convert 3D models (.fbx/.gtlf/.glb) to the ARR internal format (.arrAsset)
|
||||
* start an ARR session to load
|
||||
* render the model remotely
|
||||
* modify its materials
|
||||
|
||||
For more information on the input formats supported by ARR, see [Supported source formats](https://docs.microsoft.com/en-gb/azure/remote-rendering/how-tos/conversion/model-conversion#supported-source-formats)
|
||||
|
||||
## Setting up your accounts
|
||||
|
||||
To use ARRT, you can access the configuration panel by clicking on the gear icon on the toolbar.
|
||||
You'll have to set up two subscriptions:
|
||||
|
||||
### Azure Remote Rendering subscription
|
||||
|
||||
If you don't have a subscription, follow the steps in [Create an Azure Remote Rendering account](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#create-an-account).
|
||||
|
||||
Once you gain access to the subscription, you need to retrieve **domain**, **ID**, and **key** from your [account credentials](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#retrieve-the-account-information) and enter them in the configuration panel.
|
||||
|
||||
### Azure Storage Account (for asset conversion)
|
||||
|
||||
To create an account, see [Create an Azure Storage Account](https://docs.microsoft.com/azure/storage/common/storage-account-create).
|
||||
|
||||
To upload files, you need one or more Blob containers in your storage account. See [Quickstart: Upload, download, and list blobs with the Azure portal](https://docs.microsoft.com/azure/storage/blobs/storage-quickstart-blobs-portal)
|
||||
|
||||
To find the credentials to enter in the ARRT configuration panel, open the Azure portal and open your storage account. Look in "Access Key" and "Properties" under the "Settings" group on the left column. Find **Name**, **Key** under Access Key, and **Primary Blob Service Endpoint** under Properties.
|
||||
|
||||
An alternative way to configure your storage account is to use the [Microsoft Azure Storage Explorer](https://azure.microsoft.com/features/storage-explorer/)
|
||||
|
||||
## The main toolbar
|
||||
|
||||
![Main toolbar](media/toolbar.png)
|
||||
All the main panels are accessible from the main toolbar on the top side.
|
||||
|
||||
From left to right you have:
|
||||
|
||||
* [Settings Panel](settings-panel.md)
|
||||
* [Upload](upload.md)
|
||||
* [Convert](conversion.md)
|
||||
* [Render](rendering.md)
|
||||
* [Log Panel](log-panel.md)
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: Log panel in Azure Remote Rendering Asset Tool
|
||||
description: Panel to visualize the logs in ARRT
|
||||
author: mafranc
|
||||
ms.author: mafranc
|
||||
ms.date: 03/23/2020
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Log panel
|
||||
|
||||
![Log panel](media/logpanel.png)
|
||||
|
||||
Any operation might produce an output that is displayed in the log panel. To open the panel, click on the "Log" button on the main toolbar. That button will also show the number of new log entries, when the panel isn't visualized.
|
||||
|
||||
Each log entry in the log list has a message type (Debug, Info, Warning, Error) which can be filtered with the buttons in the log toolbar.
|
||||
|
||||
On the right side of that toolbar, you can switch between "Simple" and "Detailed" view. The detailed view shows timestamp and code location.
|
После Ширина: | Высота: | Размер: 872 KiB |
После Ширина: | Высота: | Размер: 54 KiB |
После Ширина: | Высота: | Размер: 51 KiB |
После Ширина: | Высота: | Размер: 48 KiB |
После Ширина: | Высота: | Размер: 64 KiB |
После Ширина: | Высота: | Размер: 39 KiB |
После Ширина: | Высота: | Размер: 872 KiB |
После Ширина: | Высота: | Размер: 106 KiB |
После Ширина: | Высота: | Размер: 48 KiB |
После Ширина: | Высота: | Размер: 55 KiB |
После Ширина: | Высота: | Размер: 417 KiB |
После Ширина: | Высота: | Размер: 12 KiB |
После Ширина: | Высота: | Размер: 34 KiB |
|
@ -0,0 +1,83 @@
|
|||
---
|
||||
title: Rendering in Azure Remote Rendering Asset Tool
|
||||
description: Workflow to load, rendered a model, and modify materials in ARRT
|
||||
author: mafranc
|
||||
ms.author: mafranc
|
||||
ms.date: 03/23/2020
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Rendering
|
||||
|
||||
If you already converted an arrAsset model and you would like to visualize it, click on the "Rendering" button on the main toolbar.
|
||||
|
||||
You can also do that while conversions are running, as the two environments (Conversion/Rendering) run independently from each other.
|
||||
|
||||
The workflow to visualize and edit a model is made of three steps:
|
||||
|
||||
## 1. Start new session
|
||||
|
||||
![Start New Session](media/startsession.png)
|
||||
To render a model, we need to start the ARR service, by creating a remote rendering session. If the session isn't running yet, clicking on "Rendering" will show the "session panel" on the right. From this panel you can select the parameters for a new session, like the VM size, the maximum lease time, and select an automatic lease extension. The lease time can be extended while the session is running.
|
||||
|
||||
The automatic extension option will make sure the session is automatically extended by the specified amount of minutes, if you get close to the expiration time while using ARRT. For more information on the session types, see [Create Session](https://docs.microsoft.com/azure/remote-rendering/how-tos/session-rest-api#create-a-session).
|
||||
|
||||
If you press the button "Start", a session will be created and automatically connected. This operation will require some time. Once the connection is established, this panel will collapse and the load model panel will become accessible.
|
||||
|
||||
### Visualize the session status
|
||||
|
||||
If the session is running, you can monitor its status by expanding the session panel anytime you need.
|
||||
![Session Info](media/statuspanel.png)
|
||||
From the panel you can:
|
||||
|
||||
* visualize the status and configuration of the session
|
||||
* extend the lease time by entering an amount of time, and pressing "Extend"
|
||||
* set up an automatic time extension by clicking on "Auto Extend"
|
||||
|
||||
Whenever the session will be near expiration time, if "Auto Extend" is active the lease time will be extended by the amount of time entered in the text field.
|
||||
|
||||
> Note:
|
||||
> the lease time cannot be reduced. Be careful when using the extend time function.
|
||||
|
||||
To have more details on the running session, you can click on "Inspect Session". This action will open the ArrInspector tool in a default browser. For more information about the ArrInspector, see the [ArrInspector tool documentation](https://docs.microsoft.com/azure/remote-rendering/resources/tools/arr-inspector).
|
||||
|
||||
The session can be stopped with the "Stop Session" button.
|
||||
|
||||
## 2. Load a model
|
||||
|
||||
![Loading model](media/loading.png)
|
||||
Once the session is running, you have access to a panel to load a model. By using the combo box "Input mode" on the top of the page, you can select one of the two ways to load a model:
|
||||
|
||||
* From **storage container**. This option uses a blob explorer similar to the one used in the conversion configuration. You can locate a model and double-click it.
|
||||
* From **SAS Url**. In this panel you can simply paste a SAS URL of your model. For more information about SAS URLs, go to [Grant limited access to Azure Storage resources using shared access signatures (SAS)](https://docs.microsoft.com/azure/storage/common/storage-sas-overview).
|
||||
|
||||
While the model is loading, you can see the status and the progress bar on the bottom.
|
||||
|
||||
## 3. Visualize the model
|
||||
|
||||
![Rendering View](media/renderingview.png)
|
||||
If the model is loaded correctly, the model will be shown in a new view. On the top the model name is visualized, and a button allows you to unload the model.
|
||||
In the view there are four vertical panels, which can be resized vertically. From left to right:
|
||||
|
||||
### Scene tree
|
||||
|
||||
This panel shows a tree view with the hierarchy of all the entities in the loaded model. You can expand every node, and select them.
|
||||
|
||||
### Viewport
|
||||
|
||||
The viewport shows the rendered model, streaming it from the ARR service. The camera controls are:
|
||||
|
||||
* WASD keys or arrow keys to move the camera on the horizontal plane
|
||||
* QE keys, +- keys, or Page Up and Page Down keys to move the camera vertically
|
||||
* Right mouse button, 4682 keys, Insert Home Delete End keys, or ZXFC keys to rotate the camera
|
||||
* SHIFT modifier to increase the camera movement speed by a factor of 10
|
||||
|
||||
Entities can be selected by clicking on them on the viewport. When you select an entity from the viewport, the corresponding entity gets selected and highlighted in the scene tree, and the other way around.
|
||||
|
||||
### Material list
|
||||
|
||||
This panel shows a list of the materials in the selected entities, or, if there's no selected entity, it shows the full list of materials. Materials can be selected with mouse click.
|
||||
|
||||
### Material properties
|
||||
|
||||
When a material is selected, this panel shows all of its editable properties. You can change properties (colors, parameters, flags) and see the results immediately reflected in the rendered model. There is no support for editing the material textures. For more information on the supported ARR materials, see [Materials](https://docs.microsoft.com/azure/remote-rendering/concepts/materials)
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: Settings panel
|
||||
description: Settings Panel in Azure Remote Rendering asset tool
|
||||
author: mafranc
|
||||
ms.author: mafranc
|
||||
ms.date: 03/23/2020
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Settings panel
|
||||
|
||||
![Settings panel](media/settings.png)
|
||||
|
||||
To access the settings panel, click on the gear button on the top-right corner.
|
||||
|
||||
The panel allows you to change the following settings for ARRT:
|
||||
|
||||
* Remote Rendering account.
|
||||
* Blob storage account. For instruction on how to set up your ARR and Blob storage accounts, see [Setting up your accounts](index.md#setting-up-your-accounts)
|
||||
* Video settings, like the video resolution, fps, and the navigation controls.
|
||||
|
||||
> Note:
|
||||
> To apply a different video resolution and fps on a running session, you can press the button "Apply" after making the changes. This will force a reconnection to the runtime, which will unload any model that is currently loaded.
|
||||
|
||||
All of the changes are immediately applied after editing.
|
||||
|
||||
The configuration is persisted in a json file stored in *%LocalAppData%/Arrt/config.json*
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: Upload models in Azure Remote Rendering asset tool
|
||||
description: Workflow to upload models for conversion in ARRT
|
||||
author: mafranc
|
||||
ms.author: mafranc
|
||||
ms.date: 03/23/2020
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Upload models in Azure Remote Rendering asset tool
|
||||
|
||||
![Upload panel](media/upload.png)
|
||||
To convert a 3D model, first it has to be uploaded to one the containers in your Azure Storage account. To do so, click on the "Upload" button on the main toolbar.
|
||||
Select the container where you want to upload the model using the combo-box on the top.
|
||||
|
||||
## Selection of the destination directory
|
||||
|
||||
To select a destination directory, you can navigate to it by double clicking on it in the blob list. Alternatively, you can click on the right arrow on one of the directory buttons, to navigate to one of its sub-directories.
|
||||
|
||||
To select a new directory, click on the "Add Sub-Directory" button, with a folder and a plus sign, enter the name of a new directory and press enter.
|
||||
|
||||
## Upload
|
||||
|
||||
To upload files from your local hard drive into the current root directory, you can:
|
||||
|
||||
* drag and drop the files directly into the list
|
||||
* click on the "Upload files" button on the bottom. From that file dialog you can multi-select files and directories, which will then be transferred to your blob container.
|
53
README.md
|
@ -1,5 +1,56 @@
|
|||
---
|
||||
title: Azure Remote Rendering asset tool (ARRT)
|
||||
description: Azure Remote Rendering asset tool welcome page
|
||||
author: mafranc
|
||||
ms.author: mafranc
|
||||
ms.date: 03/23/2020
|
||||
ms.topic: article
|
||||
---
|
||||
|
||||
# Contributing
|
||||
# Azure Remote Rendering asset tool (ARRT)
|
||||
|
||||
![ARRT material editing view](Documentation/media/ARRT.png)
|
||||
|
||||
Azure Remote Rendering asset tool (ARRT) is a desktop application developed in C++/Qt that can be used to:
|
||||
|
||||
* control the model conversion
|
||||
* create a remote rendering session
|
||||
* load a model
|
||||
* preview the model
|
||||
* modify its materials
|
||||
|
||||
It can be used as a sample application to learn how to implement a front end for the ARR C++ SDK, using the [Azure Storage Client Library](https://github.com/Azure/azure-storage-cpp) for managing the 3D model conversion.
|
||||
|
||||
## General Prerequisites
|
||||
|
||||
To use ARRT, you need a working remote rendering account. See [Azure Remote Rendering account](https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account) to create an ARR account.
|
||||
|
||||
You need to be familiar with the following key concepts:
|
||||
|
||||
* [Sessions](https://docs.microsoft.com/azure/remote-rendering/concepts/sessions)
|
||||
* [Models](https://docs.microsoft.com/azure/remote-rendering/concepts/models)
|
||||
* [Model conversion](https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion)
|
||||
|
||||
## Prerequisites to compile and run ARRT from git repo
|
||||
|
||||
* Visual studio 2017 or newer
|
||||
* Qt 5.13.1 or newer. Find the installation on the [website](https://www.qt.io/download-qt-installer). Use the default installation options. If you want to debug the Qt code, select the source code. Make sure the Qt5_DIR environment variable is set
|
||||
* CMake version 3.16. Find the installation [here](https://cmake.org/download/). Make sure CMake is in the PATH environment variable
|
||||
* Command-line NuGet from [here](https://www.nuget.org/downloads). Make sure Nuget.exe is in the PATH environment variable
|
||||
* HEVC driver (if not present already). For more information about the system requirements for ARR, see [System requirements](https://docs.microsoft.com/azure/remote-rendering/overview/system-requirements)
|
||||
|
||||
## Compiling ARRT
|
||||
|
||||
* Clone the GitHub Repository [Azure Remote Rendering Asset Tool](https://github.com/Azure/azure-remote-rendering-asset-tool)
|
||||
* From the root directory, run the script GenerateSolution.bat -vs2017. The script will run CMake and generate a Visual Studio solution you can open with Visual Studio 2017
|
||||
* Compile ARRT from Visual Studio (Debug or Release)
|
||||
* Run
|
||||
|
||||
## Documentation
|
||||
|
||||
* [ARRT User Documentation](Documentation/index.md)
|
||||
|
||||
## Contributing
|
||||
|
||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||||
|
|