Delegation of Commands

Instance Naming

RealityScan allows you to open up to 4 instances at once. This means that you can have 4 projects open in RealityScan at the same time.
When using the command-line interface, you can name individual instances and then delegate commands into an already opened instance – with the use of the command setInstanceName with a parameter instanceName. The name of the instance cannot contain spaces.

EXAMPLE - the following will set the name of the instance to RS1:

Delegation of Commands

You can delegate a command or a sequence of commands to an already opened instance of RealityScan using the command delegateTo with these 2 parameters: instanceName and commandsDefinition. Instead of instanceName, you can use the star symbol (*). In this case, the command is delegated to the first instance found.

EXAMPLE 1 - to add an image to the first, already opened instance of RealityScan, write:

EXAMPLE 2 - for adding an image to the instance of RealityScan named RS1, use:

EXAMPLE 3 - this adds every fifth image from a specified folder, aligns the images, saves the project and quits the app:

Waiting for Completion

There is also the command waitCompleted for pausing the execution of other commands until the current process is finished. When using this command along with the parameter instanceName (or the * symbol), the following commands are executed only once the process is finished in the instance that the command is referring to. See the example below.

EXAMPLE - run alignment in the first instance found, wait with the batch execution until the alignment process is finished and then check the result of the process:

Checking Instance Status

Use the command getStatus along with instanceName (or an asterisk "*") to return the progress of a running instance.

EXAMPLE - retrieves the current status from an already opened instance RS1:

RESULT - in the console of that specific instance, you will get the result in the form of the progress ID, progress percentage of the current process, elapsed time, and estimated time:

You can also print the result of getStatus to an external text file. The command would look as such:

Controlling Process

You can use commands pauseInstance, unpauseInstance, and abortInstance along with the parameter instanceName (or a * symbol) to control the currently running processes inside of an opened instance of RealityScan. This is beneficial mainly when processing on servers or render farms. These commands allow you to pause a current process in case there is a need to run the process with a higher priority. Afterwards, you can again unpause the previous process, when needed. Alternatively, you can abort the process completely.

EXAMPLE - pause a process running in the instance RS1: