FVS Unity Component

This document is applicable to users who have installed the FineVis Data Visualization plugin to learn the plugin functions.

Version

Application Scenario

Unity is a real-time 3D development platform. To enhance user experience with more immersive 3D effects, FVS has integrated the Unity component developed by Unity, allowing you to import, edit, save, and preview Unity resources. 

The Unity component can extend the FVS 3D function while seamlessly integrating with the existing FVS design. For example, you can configure the Unity component with FVS data sources or customize interaction events (such as linkage, jump, and parameter passing).

Note:

1. Only the Unity versions released after 2021.3 are supported.

2. The function is not supported on mobile terminals.

Before using the Unity component, you need to develop the 3D scene in Unity first, and then export the WebGL resource package and upload it to FVS.

Note:

1. In FVS, the configurations related to Unity scenes, data, and styles are determined and automatically generated by the resources themselves. FVS supports modifications only after the configuration files have been parsed.

2. Unity scene development is based on FVS-Unity-SDK.

This document provides three examples of Unity resource compression packages.

• Relatively small file (7.55 M) with simple resources: Build1.zip

• Relatively big file (79.9 M) with impressive resources: Exhibition Hall Unity Resources.zip

• Relatively big file (143 M) with multi-scene resources (applicable to FineReport with the FVS plugin of V1.8.2 and later versions): Multi-Scenario Unity Resources.zip

You do not need to unzip the packages after downloading them.

1. Choose File > New FineVis Visualization Dashboard in the upper left corner of the designer to create a dashboard. You can customize the dashboard name and canvas size, as shown in the following figure. 

Choose 3D > Unity to add the Unity component to the canvas. Choose Content > Edit Component in the right configuration area to enter the Unity scene editing page.

Uploading the Unity Resource

When you enter the Unity component editing page for the first time, you will be prompted to upload the Unity resource before proceeding with configurations.

Click Upload Unity Resource. In this example, upload Exhibition Hall Unity Resources.zip in the section "Unity Resources Preparation." Wait for a moment, and the Unity scene will be loaded, as shown in the following figure.

Scene Configuration

After the Unity resources are parsed, the Scene panel exists by default and inherently includes the Refresh Unity Setting and Replace Unity functions.

If the resources contain scene-related configurations, the corresponding configuration items will appear on the Scene panel.

Refreshing the Unity Setting

After you click Refresh Unity Setting, all configurations modified in FVS will be restored to the original resource setting, except for the bound data and adjusted viewing angles.

Unity Multi-Scene Switching

In Unity, you can create multiple scenes and package them into a single Unity resource, where each scene has its own data, styles, or event settings.

In FineReport with the FVS plugin of V1.8.2 and later versions, if the imported resource package contains multiple scenes, the FVS Unity component can recognize and allow you to switch between these scenes. Upon switching, the configuration panel will be updated accordingly to match the current scene, as shown in the following figure.

Replacing the Unity Resource

You can click Replace Unity, and select another Unity resource package to replace the current Unity resource.

When you replace resources, the Unity component will parse the configuration file of the new resource and update the configuration items accordingly.

Data Configuration

When FVS parses Unity resources, it will automatically generate data layers and field names based on the data configuration information.

You cannot create or delete data layers in FVS, but you can set data sources and bind data.

Take Exhibition Hall Unity Resources.zip uploaded in the section "Uploading the Unity Resource" for example. The following figure shows the Data configuration panel of the Unity resource.

Note:

When creating datasets in FVS, note that the model name is defined by the Unity resource. For example, the Venue Name field must be identical to the model name in the Unity resource.

Note: If the Unity resource has style attribute settings, a Style configuration panel will be automatically created as well.

1. The Unity component supports six types of click events via FVS component interaction attributes, enabling interactions such as component linkage and page jump.

Take Exhibition Hall Unity Resources.zip uploaded in the section "Uploading the Unity Resource" for example. When you add a click event for the Unity component, two event objects are available, namely Venue Click and Camera Click.

Once you have selected the event object, you can select the event type.

Note:

The event object here does not require data layer configuration, but only relies on the settings of the Unity resource.

2. If the Unity resource contains configurable animations, you can set corresponding 3D component animation click events for other components to trigger the animation effects of the Unity component.