The Script Editor allows you to edit Shaders and VSL Scripts directly from the 3DVIA Studio interface. Although scripts can still be created and edited with any text editor outside the 3DVIA Studio environment, then imported to the 3DVIA Studio application for project use, the Script Editor incorporates extended editing features – like syntax coloring and code completion – to facilitate the scripting process.

The Script Editor is also used to launch the compilation process and to check the assembly-like generated code.

Click to enlarge

Main Window Features

The main window contains the editable code. Editing features include cut, copy, paste, word by word cursor moves and selection. Here is a description of these main features:

• Auto Completion: Completes a word without requiring you to type it in completely.
• Syntax Coloring: Provides visual help by definining a color for each token and grammar rule.
• Tooltips: Provides additional variable information.
• Opcodes: User-friendly assembly-like generated code.

Auto Completion

An auto-completion menu appears automiatically when:

• Accessing a type member (using the dot operator “.“).
• Accessing a namespace (using the operator “::“ ).
• Writing a type.

to show recognized types, functions, syntax commands, and so on, in the current type’s member list, namespace or namespace’s type list.

After accessing a namespace, the auto-complete context menu is filtered with the word currently written.

• - Type
• - Method / function
• - Member
• - Enum value
• - Typedef
• - Syntax

Tooltips

A tooltip with corresponding function signature appears in the following situations:

• When writing or editing a function’s parameters.
  The argument being written is colored in red. In case of function overloading, the arrow key can be used to show the next signatures.

  

• When the mouse is over a variable.
  The tooltip gives information about the variable type.

  

Syntax coloring

• Keywords are colored in blue.
• Types are colored in dark blue.
• Strings are colored in red.
• Comments are colored in green.

Informative margin icons

Margin icons report errors on the corresponding lines of code.

Assembly

The assembly is useful when analyzing the generated code.

Console

The script console shows the compilation message.

• Errors
• Warnings
• Messages

Double clicking on a compilation message entry will focus the Editor to the file and line number where the error has been detected.

Status Bar

The status bar informs the user about:

• The script compilation state :
  • Compiled
  • Uncompiled
• The current line and column in the editor.

Compilation Results

The upper-right area of the script Editor shows the code generated after the compilation of the current script.

Script Editor Toolbar

• Assembly button is used to show the compilation result in the upper right splitscreen area. If the compilation failed, this field remains blank, but an error message should belocated in the console dialog.
• Console: show/hide console.
  
• Compile: compile script.

Preferences

Syntax colors can be changed in the preferences dialog:

Some standard editor options are available:

• Script_auto Complete: Enables auto completion when typing.
• Script_indentation: Enables auto indentation when entering a new line
• Script_close Separators: Enables writing open’s and close’s separator (“{}”, “[]”, ..)
• Script_auto Clear Console: Enables to clear the console automatically.
• Script_save on compile: If enabled, the script is automatically saved after a succefful compilation.
• Script_max Completion: Defines the maximum number of entry in the completion menu.

Keyboard Shortcuts

All interactions in the script editor use keyboard/Mouse. These default accelerators can be changed in the preferences dialog.

• Up/down keys : Choose the corresponding entry in the code completion context menu. Can be also used in signature tooltip to select a different overload.
• Ctrl+Space: Toggle autocompletion menu.
• Ctrl+C/Ctrl+V/Ctrl+X : Copy/Paste/Cut commands.
• Ctrl+E : Go to scope (select matching ‘{‘ or ‘}’.
• Ctrl+Z/Ctrl+Y : Undo/redo commands.
• Ctrl+D: Go to definition (focus document defining the selected type name or signature).
• Ctrl+A: Select all.
• Ctrl+S: Save the script.
• F7: Compile current script.
• Ctrl+F7: Force compilation of current script (compile it even if the script is up to date).
• Ctrl+G: Opens the “go to line” dialog.
  
  
• Ctrl+F: Opens the “Find” dialog.
  
• F3: Find next occurence of the word being searched (when focused in the editor).
• Shift+F3: Find previous occurence of the word being searched.
• Ctrl+F3: Find next occurence of selected word.
• Shift+F3: Find previous occurence of selected word.