View Configuration / Toolbox Changes

View configuration files from previous versions should continue to work with 2019.4.

However, there have been some changes in where the files are stored, as well as changes which require specific license features relating to view configuration usage.

Custom View Configuration Files

If you are using a custom view configuration by using the -viewconfig parameter on the Visionary Render shortcut / command line, this now requires an Immersive license feature.

  1. If you are already using a tracker such as ART or Intersense with Visionary Render, you already have this feature.
  2. If you do not have this feature, the view configurations will not be loaded from the specified file and you will receive a license dialog prompt requesting an Immersive license
  3. Changes to preset view configurations (i.e. the desktop mode, or desktop immersion modes such as Steam VR or Oculus) result in a prompt to save a new view configuration. This also requires the Immersive license

If you do not already have an Immersive license and are making use of custom view configuration files, please contact support@virtalis.com 

Complex View Configurations

If you are using a complex view configuration containing more than 4 Viewports, there are now additional license features required to support this.

In most cases, view configurations do not require more than 4 Viewports, except when supporting a large cluster or cave with more than 4 sides.

  1. If your view configuration requires more than 4 Viewports and you have already upgraded past Visionary Render 2.0, you will have already been provided updated licenses with this feature
  2. If you do not have this feature, some of the Viewports will be ignored and you will receive a license dialog prompt requesting an AdditionalViewports license

If you are an existing 1.3.x user currently using this type of view configuration to support a cluster or other system that we provided, we are providing updated licenses free of charge during your upgrade process. Please contact support@virtalis.com 

View Configuration and Toolbox file locations

In Visionary Render 1.3.x and earlier, view configuration and toolbox files were expected to exist in the application data directory (e.g. C:\Virtalis\Visionary Render\data) and any changes to these files were written back to this directory.

In Visionary Render 2.0 and later, this data directory is treated as read-only.

When view configuration or toolbox files are specified, the system first looks in the user documents folder where other application settings are stored.

  1. This directory defaults to C:\Users\<user.name>\Documents\VisionaryRender\configs
  2. The location of this directory can be overridden by setting the VRCONFIGDIR environment variable

If there are no matching configuration files in these locations, the system will fall back to the contents of the application data directory. However, the files it finds here are copied to the new location and that copy is loaded from then on. Any changes to the original files in the data directory will not take effect if there is already a copy in the new location.

There are a number of ways to accommodate this change:

  1. If your view config rarely changes (i.e. it's supporting a tracking system configuration), the recommended approach is to place the pristine working view configuration in the application data directory, and allow the system to automatically clone it as necessary.
    1. If you have upgraded in-place (the installation of 2019.4 replaced 1.3.x), these files will already be in the correct location
    2. If you have upgraded using the side-by-side installation method, you will need to copy the configuration files from your 1.3.x data directory into the 2019.4 data directory
  2. If your view config is subject to change and having multiple copies is not the preferred approach, you have two other options
    1. Set the VRCONFIGDIR environment variable to contain a path to a folder you wish to use to store configs. Make sure this is accessible by all users who use the system by setting a "system environment variable" rather than a "user environment variable", and ensure the directory permissions allow access from all the user accounts who will be using the system
    2. Change the -viewconfig and -toolbox parameters to use absolute paths, (e.g. a full path C:\myconfigs\view.VRText), in which case the config file management system will simply use the files in-place at all times when possible. If using this method, ensure the directory containing the view configurations is writable. If the system cannot write to the specified files, it will fall back to using the new location (either Documents directory or value of VRCONFIGDIR environment variable).

Toolbox tool enabled states

Since Visionary Render 2.2, the tools in the toolbox are enabled and disabled via settings, rather than via Enabled properties on the tools themselves.

This one-time migration does not preserve any saved tool enabled state - tools will be reverted back to their default enabled states. All other settings of the tools remain untouched and will continue to function as before.

This removal of the Enabled properties does mean that some methods of controlling these tools via Lua scripts will no longer function. Details about how to update your usage of the Lua API in these circumstances can be found in the programming guide under "Change Log → Changes between Visionary Render 2.1.0 and Visionary Render 2.2.0".

J
Jamie is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.