From the following lists, you can access Vicon Shogun Post script commands by category.
Use the commands in this category to edit your mocap data.
Use the commands in this category to control data management.
| Data management commands | |
|---|---|
| getEclipseActiveTrial | getSession |
| getEclipseAssociatedCalibration | openEclipseDatabase |
| getEclipseAssociatedSubjects | refreshEclipse |
| getEclipseMarkedTrials | setSession |
Use the commands in this category to work with data.
| Data manipulators commands | |
|---|---|
| addToClip | rigidBody |
| alignAxis | selectTails |
| alignSubjects | setActiveClip |
| setBoneLength | |
| setInterpType | |
| setKey | |
| setPosition | |
| deleteClipData | setPriority |
| deleteTangents | setProperty |
| getPriority | setRotation |
| hide | setScale |
| makeRigid | show |
| moveClip | swap |
| offsetClips | tileClips |
| parent | unbreakTangents |
| removeFromClip | unlabel |
| removeRayContributions | unparent |
| removeSoftwareFitCentroids | unsetProperty |
| resetClip | updateClip |
Use the commands in this category to retrieve data.
| Data retrieval commands | ||
|---|---|---|
| delGlobalVar | getKeys | |
| getLabelerChars | ||
| getLabelingClusterOffsets | ||
| findGap | getLastFile | |
| findNonRigid | getLogFile | |
| findPlaneCrossing | getMarkerConnection | |
| findSelectedKeys | getMarkerConnectionColor | |
| findTail | getMirrorConstraintCreation | |
| findUnlabeled | getModule | |
| getActiveClip | getModuleRange | |
| getAnimEnd | getModules | |
| getAnimStart | getModuleType | |
| getAttached | getNumKeys | |
| getAttachedTo | getNumModules | |
| getBooleanArrayProperty | getParent | |
| getBooleanProperty | getPercentSubjectLabeled | |
| getChannels | getPlayEnd | |
| getChildren | getPlayStart | |
| getClips | getPosition | |
| getProperty | |
| getRate | ||
| getConstraintOffset | getRotation | |
| getConstraintPos | getScale | |
| getSelectedKeys | ||
| getSelectedTimeRanges | ||
| getContributingCameras | getSolverBones | |
| getCount | getStringArrayProperty | |
| getCurrentLabel | getStringProperty | |
| getDistance | getSubjectSolvingConstraintError | |
| getFloatProperty | getTime | |
| getGaps | getTimecode | |
| getGlobalBooleanVar | getTrajectories | |
| getGlobalFloatVar | getVectorProperty | |
| getGlobalIntVar | hasKey | |
| getGlobalStringVar | isSelected | |
| getGlobalVectorVar | offlineCameraHealthCheck | |
| getIntArrayProperty | setGlobalVar | |
| getIntProperty | ||
Use the commands in this category to control data streaming.
| Data streaming commands | |
|---|---|
| offlineDataProvider | offlineDataProviderOptions |
Use the commands in this category for data input and output.
| Disk I/O commands | |
|---|---|
| fileClose | readRot |
| fileOpen | readString |
| getFilePath | readToken |
| getFilePos | readVec |
| getFiles | readWord |
| isEndOfFile | seekToString |
| isFileBinary | setFilePos |
| isFileReadable | writeBool |
| isFileWriteable | writeFloat |
| readBool | writeInt |
| readFloat | writeRot |
| readInt | writeString |
| readLine | writeVec |
Use the commands in this category for file handling.
| File handling commands | |
|---|---|
| bvhExportOptions | saveFile |
| c3dExportOptions | trcExportOptions |
| c3dImportOptions | usdExportOptions |
| fbxExportOptions | usdImportOptions |
| fbxImportOptions | vskExportOptions |
| importMesh | vsrExportOptions |
| loadFile | vssExportOptions |
| mcpExportOptions | vstExportOptions |
| mcpImportOptions | x2dImportOptions |
| newFile | xcpImportOptions |
| resetScene | |
Use the command in this category to help you to work with Vicon hardware.
Use the commands in this category to work with the Shogun user interface.
| User interface commands | ||
|---|---|---|
| appInfo | loadScript | |
| autohideWindow | loadWorkspaceString | |
| cameraView | manipulator | |
| camerasView | messagePrompt | |
| closeScript | playblast | |
| createFloatingView | progressBar | |
| createShelfButton | removeFloatingView | |
| createShelfGroup | renameShelfGroup | |
| createShelfSeparator | renameShelfTab | |
| createShelfTab | saveScript | |
| dataHealthView | saveWorkspaceFile | |
| dataIssuesMap | selectShelfTab | |
| deleteShelfGroup | setActiveFloatingView | |
| deleteShelfTab | setButtonShelfFile | |
| dockWindow | setEditTool | |
| floatWindow | setFloatingViewPos | |
| getActiveShelfTab | setFloatingViewSize | |
| getActiveView | setPinned | |
| getActiveViewType | setSelectionFilter | |
getCurrentScript
| setSolversFirst | |
| getEditTool | setTrackList | |
| getNumShelfTabs | setViewFilter | |
| getSelectionFilter | setWindowSize | |
| showMarkingMenu | ||
| getViewFilter | showCtrlMarkingMenu | |
| getViewLayout | showShiftMarkingMenu | |
| getViewTypes | tabWindow | |
| graphView | viewLayout | |
| hierarchyView | wait | |
| isAxiomEnabled | zoomView | |
Use the commands in this category to work with labeling.
| Labeling commands | |
|---|---|
| autoCreateLabelingClusters | createLabelingCluster |
| autoLabel | createPropVST |
| autoLabelOptions | createPropVSTOptions |
| autoVST | kinematicLabelOptions |
| autoVSTOptions | kinLabel |
| calibrateLabelingCluster | removeMarker |
| calibrateLabelingClusterOptions | scaleCharacter |
| tPoseLabel | |
| calibrateLabelingSubjectOptions | tPoseLabelOptions |
| uncalibrateLabelingCluster | |
| calibratePropOptions | velocityLabel |
| calibrateSolvingSubjectOptions | velocityLabelOptions |
Use the commands in this category to enable or disable the DBS (Distributed Batch System) master and/or slave.
Use the commands in this category to work with math-related information.
| Math commands | |
|---|---|
| abs | getAngleTo |
| acos | getLength |
| asin | getPointClosestTo |
| atan | normalize |
| calcIntersection | setLength |
| cos | sin |
| cross | squareRoot |
| dot | tan |
| fabs | |
Use the commands in this category to work with namespaces.
| Namespace commands | |
|---|---|
| addNamespace | removeNamespace |
| getNamespace | replaceNamespace |
| getNamespaces | |
Use the commands in this category to work with layers and clips.
| NLE commands | |
|---|---|
| addLayer | removeLayer |
| flatten | selectClipObjects |
| getActiveLayer | setActiveLayer |
| getLayers | |
Use the commands in this category to work with parameters.
| Parameters commands | |
|---|---|
| addParameter | removeAllParameters |
| addStaticParameter | removeParameter |
| getParameter | removeUnusedParameters |
| renameParameter | |
| selectByParameter | |
| getParameters | setParameter |
| getParameterType | setParameterPrior |
| getParameterUserValue | setStaticParameterExpression |
| hasParameter | setStaticParameterUserValue |
| listParameters | |
Use the commands in this category to control playback of mocap data.
| Playback control commands | |
|---|---|
| animRange | setTime |
| fastForward | setTimebarRange |
| play | setTimebarRangeToAnimRange |
| playOptions | setTimebarRangeToPlayRange |
| playRange | setTimebarRangeToSelectedRange |
| rewind | step |
| setAudioEnabled | stepKey |
| setRangesFollowActiveClip | stop |
Use the commands in this category to control communications between Shogun and a remote server.
| Remote control commands | |
|---|---|
| client | sendRemote |
| remoteControl | server |
Use the commands in this category to control retargeting.
| Retargeting commands | |
|---|---|
| retarget | setRetargetingMapModeEnabled |
Use the commands in this category to work with selection.
| Selection commands | |
|---|---|
| getSelectionSetNodes | selectByType |
| getSelectionSets | selectChildren |
| getSelectionSetSets | selectionSet |
| isSelectionSet | selectKeys |
| select | selectMarkersForRigidFill |
| selectabilityOn | selectParent |
| selectBranch | selectProperty |
| selectByDistance | selectRange |
| selectByMarkerRadius | selectRelatedKeys |
| selectByName | selectSet |
| selectByPart | selectTree |
| selectByRigidity | setChannelSelectionFollow |
| selectBySide | setPrimary |
Use the commands in this category for solving marker data to a skeletal format.
| Skeletal solving commands | |
|---|---|
| attach | moveRotationKeyToPreRotation |
| attachCommandOptions | moveTranslationToPreTranslation |
| autoCreateSolver | multiplyJointRange |
| autoSetupSolvingSkeleton | multiplyJointStiffness |
| autoSetupSolvingSkeletonOptions | removeBone |
| calibrateSolvingSubject | retarget |
| createConstraintsScript | scaleBones |
| createSkelScript | scaleSkeletalMotion |
| createSolvingSetupFromLabelingSetup | setConstraint |
| getInteractiveRetargetCmd | setInteractiveRetargeting |
| getInteractiveSolveLabeling | setInteractiveSolveLabeling |
| getInteractiveSolveSolving | setInteractiveSolveSolving |
| getSolversFirst | setPreferredPose |
| getUseAxiomSolving | setUseAxiomSolving |
| goToBasePose | skelSetup |
| goToBindPose | solve |
| goToPreferredPose | solver |
| insertBone | |
Use the commands in this category to snap markers or nodes to specified locations.
| Snap commands | |
|---|---|
| snapTo | snapToLocal |
| snapToConstraint | snapToRigid |
| snapToLine | snapToSystem |
Use the commands in this category to handle strings in mocap data.
| String commands | |
|---|---|
| strCompare | strReplace |
| strFind | strReverseFind |
| strLeft | strRight |
| strLength | strTok |
| strMid | strTokArray |
Use the commands in this category to work with subjects.
| Subjects commands | |
|---|---|
| getCurrentChar | setAutoSwitchCurrentSubject |
| getCurrentSubject | setCurrentSubject |
| getPropsPath | setPropsPath |
| getSubjectsPath | setSubjectsPath |
| replaceSubjects | |
Use the commands in this category to interact with the Vicon system and Shogun.
| System commands | ||
|---|---|---|
| addScript | playSound | |
| addScriptPath | ||
| assert | processFile | |
| python | ||
| clearScriptPaths | redo | |
| copyString | resample | |
| createDir | runScript | |
| createSceneScript | scriptExists | |
| deleteFile | setActiveTake | |
| setAltToSelect | ||
| setAutoSaveFile | ||
| formatTime | setBackupPlfsEnabled | |
| frameToSmpte | setControlToManipulate | |
| getActiveTake | setDir | |
| getAutoSaveFile | setErrorHandler | |
| getClipboardText | setExitCode | |
| getDirList | setFrameRate | |
| getFileExtension | setHotKey | |
| getFileList | setHotKeyFile | |
getFileLocation
| ||
| setLogEnabled | ||
| getFileTitle | setLogFile | |
| getGlobalVarExists | setMarkingMenuFile | |
| getLastScript | setSavePath | |
| getProfileInt | setSceneName | |
| getProfileString | setScriptPaths | |
| setSelectionSetFile | ||
| getSceneName | setTimeFormat | |
| getSceneUpAxis | smpteToFrame | |
| getScriptPaths | sortFloats | |
| getSystemTime | sortInts | |
| sortStrings | ||
| system | ||
| listCommands | undo | |
| listObjectTypes | undoConsolidated | |
| markingMenu | writeProfileInt | |
| pathExists | writeProfileString | |
Use the commands in this category for testing purposes.
| Testing commands | |
|---|---|
| compareModules | testPrint |
Use the commands in this category to manage a Shogun panel (docking window) or a user window.
| User window commands | ||
|---|---|---|
| addDropListItem | getNumBoxNum | |
| addListBoxItem | getNumDropListItems | |
| addListViewItem | getNumListBoxItems | |
| addTab | getNumListViewColumns | |
| createCheckBox | getNumListViewItems | |
| createColorPicker | getRadioButtonCheck | |
| getTabItem | ||
| getTabSelItem | ||
| createGroupBox | getTimeBoxTime | |
| getTopLevelForm | ||
| createListView | getWindowRect | |
| createNumBox | getWindowVisibility | |
| createPushButton | layoutForm | |
| createRadioButton | selectDropListItem | |
| createStaticBox | selectListBoxItem | |
| createTab | selectListViewItem | |
| selectTabItem | ||
| createTimeBox | setCheckBoxCheck | |
createWindow
| setCheckBoxHandler | |
| deleteAllDropListItems | setColorPickerColor | |
| deleteAllListBoxItems | setColorPickerHandler | |
| deleteAllListViewItems | setControlAnchor | |
| deleteAllTabItems | setControlPos | |
| deleteDropListItem | setControlText | |
| deleteListBoxItem | setControlTip | |
| deleteListViewItem | setDropListHandler | |
| setFocus | ||
| setListBoxHandler | ||
| setListViewColumns | ||
| enableControl | setListViewHandler | |
| fileChooser | setListViewItemCheck | |
| setListViewItemText | ||
| findListBoxItem | setNumBoxHandler | |
| findTabItem | setNumBoxNum | |
| getCheckBoxCheck | setNumBoxRange | |
| getColorPickerColor | setPushButtonHandler | |
| setRadioButtonCheck | ||
| setRadioButtonHandler | ||
| getControlText | setStaticBoxHandler | |
| getControlVisibility | setTabHandler | |
| getDropListItem | setTextBoxHandler | |
getDropListSelItem
| setTimeBoxHandler | |
| getFocus | setTimeBoxTime | |
| getListBoxItem | setWindowHandler | |
| getListBoxSelItems | showControl | |
| getListViewItemCheck | showWindow | |
| getListViewItemText | windowExists | |
| getListViewSelItems | ||