Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For information on specifying additional script folders, or changing the location of the button shelf script from the Directories tab in the Preferences dialog box, see the following topics:

Table of Contents
maxLevel2

...

Scroll only
scroll-viewporttrue
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-htmltrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
2

Set Script folder locations

Anchor
SetScriptFolderLocations
SetScriptFolderLocations

The Shogun Post Scripts folder contains the default HSL scripts supplied with Shogun, organized by category into sub-folders. By default, the Scripts folder is installed under the main Shogun program folder (C:\Program Files\Vicon\ShogunPost#.#\Scripts). Scripts in this folder can be selected from the Pipelines panel and the Script Viewer  (available from the Script Editor toolbar). You can specify additional script folders in the Preferences dialog box, on the Directories tab:

  • General menu > Preferences option > Preferences dialog box > Directories tab > Scripts tab

    Image Modified

You can specify more than one folder here, but Shogun will execute the first version of a given script file that it finds. That means that if you have two script files named greatScript.hsl, Shogun will execute the first one it finds as it searches the specified script folders in the order in which they appear in this field. You can use this search order to manage when customized scripts are used over standard Shogun scripts.

...

Shogun uses the ScriptShelves.hsl HSL script to build the Button Shelf interface. The button shelf tabs are displayed as custom tabs on the ribbon. By default, this script is located in the main ShogunPost program folder (C:\Program Files\Vicon\ShogunPost#.#). You can specify a different filename and/or location for this file on the Directories tab in the Preferences dialog box:

  • General menu > menu> Preferences dialog box > Directories tab > Scripts tab

    Image Modified

You may find it useful to create a copy of the file and/or your own folder for storing a backup file. You can specify the location of this file and/or folder as described below.

...

FolderContents
\DefaultOpsScripts that are set up specifically for use in a pipeline, though many other scripts can be used in pipelines.
\FileIOScripts relating to import to and export from Shogun Post.
\InterfaceScripts that control the 3D view, layout of views, hiding and showing of objects, etc.
\LabelingScripts that are for labeling markers.
\MayaScripts that operate on FBX imported to Maya from Shogun Post.
\ModulesScripts that operate on a single module, or collection of modules, often performing a low-level task:

\AttributesScripts that modify generic attributes of a module.

\ChannelsScripts that operate on the channels of a module. This folder contains most of the functionality for modifying keys, marker data editing, and clips that are containers of keys.

\DeletionScripts that delete things.

\HierarchyScripts that modify the parent-child relationship of modules.

\SelectionScripts that select modules.
\MXhardwareScripts that operate on optical cameras and hardware units.
\NLEScripts that perform NLE operations like shifting, blending, looping, and adjusting clip start and end.
\SolvingScripts that affect solving skeletons.
\SubjectCalibrationScripts that calibrate subjects.
\TimeScripts that change the current time or select time ranges.
\TutorialsScripts that are used in Shogun  Shogun tutorials.
\UtilitiesScripts that are generic in use and can be used to create other scripts.

...