Script

Useful resources
API documentation (script functions and tutorials)
Scripts for Cyclone 3DR (GitHub repository with advanced script samples)

Usages

The Script Plugin can be used to execute Javascript code either from the command line or the software's main Graphical User Interface.

From the application's main window

From the command Run Script.

From the command line

Command-line arguments let you start the application and run a script automatically, for example as part of a batch process or a scheduled task.

Argument	Description	Syntax
script	Open script dialog box at startup and load a script from the given file path.	`--script="D:/script.js"`
scriptOutput	Writes the console output into a given file.	`--scriptOutput="D:/output.log"`
silent	Silent Mode. Disables the Graphical User Interface (no windows).	`--silent`
scriptParam	You can specify additional scripting code, which will be executed just before the specified input script (if any). It's useful to give argument to the script from the command line. As example, you can give the .3dr filename inside a variable named fileToLoad, and then, use it inside the .js file to open that file. Sample js file which used a variable define with --scriptParam `if(typeof fileToLoad === "undefined") throw new Error("variable 'fileToLoad' must be define using --scriptParam"); var res = OpenDoc(fileToLoad); ...`	`--scriptParam="var fileToLoad='d:/Project/3drfile.3dr';"`
scriptAutorun	Automatically runs the script once the application has been initialized. This argument is not useful if `--silent` is defined.	`--scriptAutorun`

Example

The following command line instruction does the following:

Starts the application in silent mode, no window, only an icon inside the taskbar.
Executes the script SmoothPoly.js
Writes the console output into the file "D:/output.log"
Execute a code snippet before the script itself:
- declare a new variable
- print its value in the console "Use deviation control: 0.12"

3DR.exe --script="D:/Tuto/SmoothPoly.js" --scriptOutput="D:/Output.log" --silent --scriptParam="var deviation=0.12; print('Use deviation control: ' + deviation);"