From the following lists, you can access Vicon Shogun Post script commands by category.

Data editing commands

Use the commands in this category to edit your mocap data.

Data editing commands
autoFillGaps	grayscalefitOptions
axiomLabel	label
axiomLabelOptions	labelOptions
bakeData	makeUnique
bakeLengths	pack
collapse	pasteKeys
copyData	quickPost
copyKeys	quickPostLabelOptions
copyPattern	quickPostOcclusionFixOptions
create	quickPostSolveOptions
createBoneVirts	reassemble
createKey	reconstruct
createReconstructorScript	reconstructChunk
cutKeys	reconstructOptions
delete	reduceKeys
deleteCharacters	removeMarkerConnection
deleteRedundant	restoreGaps
deleteShortTrajs	setMarkerConnection
duplicate	setTimeCodeOffset
exists	snapToSystemAlign
fillGaps	transcodeVideo
filter	unpack
fixOcclusion	useProcessingSettingsFromMCP
fixOcclusionOptions	zeroKey
getTimeCodeOffset

Data management (Eclipse) commands

Use the commands in this category to control data management.

Data management commands
getEclipseActiveTrial	getSession
getEclipseAssociatedCalibration	openEclipseDatabase
getEclipseAssociatedSubjects	refreshEclipse
getEclipseMarkedTrials	setSession

Data manipulators commands

Use the commands in this category to work with data.

Data manipulators commands
addToClip	resetClip
alignAxis	rigidBody
alignSubjects	selectTails
autoCreateRetargetingConstraints	setActiveClip
autoSetSideAndParts	setBoneLength
breakTangents	setInterpType
copyClip	setKey
createTangents	setPosition
cropClip	setPriority
deleteClipData	setProperty
deleteTangents	setRotation
getPriority	setScale
hide	show
makeRigid	swap
moveClip	tileClips
offsetClips	unbreakTangents
parent	unlabel
removeFromClip	unparent
removeRayContributions	unsetProperty
removeSoftwareFitCentroids	updateClip

Data retrieval commands

Use the commands in this category to retrieve data.

Data retrieval commands
delGlobalVar	getKeys
findBadData	getLabelerChars
findDeviantKeys	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
getColor	getProperty
getConstraintError	getRate
getConstraintOffset	getRotation
getConstraintPos	getScale
getConstraintsThisIsSource	getSelectedKeys
getConstraintsThisIsTarget	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

Data streaming commands

Use the commands in this category to control data streaming.

Data streaming commands
offlineDataProvider	offlineDataProviderOptions

Disk I/O commands

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

File handling commands

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

Hardware Control commands

Use the command in this category to help you to work with Vicon hardware.

volumeVisualizerOptions

Interface commands

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
getShelfTabs	showMarkingMenu
getViewFilter	showCtrlMarkingMenu
getViewLayout	showShiftMarkingMenu
getViewTypes	tabWindow
graphView	viewLayout
hierarchyView	wait
isAxiomEnabled	zoomView

Labeling commands

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
calibrateLabelingSubject	tPoseLabel
calibrateLabelingSubjectOptions	tPoseLabelOptions
calibrateProp	uncalibrateLabelingCluster
calibratePropOptions	velocityLabel
calibrateSolvingSubjectOptions	velocityLabelOptions

Master/Slave (DBS) commands

Use the commands in this category to enable or disable the DBS (Distributed Batch System) master and/or slave.

Math commands

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

Namespace commands

Use the commands in this category to work with namespaces.

Namespace commands
addNamespace	removeNamespace
getNamespace	replaceNamespace
getNamespaces

NLE (Non-Linear Editor) commands

Use the commands in this category to work with layers and clips.

NLE commands
addLayer	removeLayer
flatten	selectClipObjects
getActiveLayer	setActiveLayer
getLayers

Parameters commands

Use the commands in this category to work with parameters.

Parameters commands
addParameter	removeAllParameters
addStaticParameter	removeParameter
getParameter	removeUnusedParameters
getParameterExpression	renameParameter
getParameterPriorValue	selectByParameter
getParameters	setParameter
getParameterType	setParameterPrior
getParameterUserValue	setStaticParameterExpression
hasParameter	setStaticParameterUserValue
listParameters

Playback control commands

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

Remote control commands

Use the commands in this category to control communications between Shogun and a remote server.

Remote control commands
client	sendRemote
remoteControl	server

Retargeting commands

Use the commands in this category to control retargeting.

Retargeting commands
retarget	setRetargetingMapModeEnabled

Selection commands

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

Skeletal solving commands

Use the commands in this category for solving marker data to a skeletal format.

Skeletal solving commands
attach	insertBone
attachCommandOptions	moveRotationKeyToPreRotation
autoCreateSolver	moveTranslationToPreTranslation
autoSetupSolvingSkeleton	multiplyJointRange
autoSetupSolvingSkeletonOptions	multiplyJointStiffness
calibrateSolvingSubject	removeBone
createConstraintsScript	retarget
createSidesAndPartsScript	scaleBones
createSkelScript	scaleSkeletalMotion
createSolvingSetupFromLabelingSetup	setConstraint
getInteractiveRetargetCmd	setInteractiveRetargeting
getInteractiveSolveLabeling	setInteractiveSolveLabeling
getInteractiveSolveSolving	setInteractiveSolveSolving
getSolversFirst	setPreferredPose
getUseAxiomSolving	setUseAxiomSolving
goToBasePose	skelSetup
goToBindPose	solve
goToPreferredPose	solver

Snap commands

Use the commands in this category to snap markers or nodes to specified locations.

Snap commands
snapTo	snapToLocal
snapToConstraint	snapToRigid
snapToLine	snapToSystem

String commands

Use the commands in this category to handle strings in mocap data.

String commands
strCompare	strReplace
strFind	strReverseFind
strLeft	strRight
strLength	strTok
strMid	strTokArray

Subjects commands

Use the commands in this category to work with subjects.

Subjects commands
getCurrentChar	setAutoSwitchCurrentSubject
getCurrentSubject	setCurrentSubject
getPropsPath	setPropsPath
getSubjectsPath	setSubjectsPath
replaceSubjects

System commands

Use the commands in this category to interact with the Vicon system and Shogun.

System commands
addScript	playSound
addScriptPath	print
assert	processFile
clearLog	python
clearScriptPaths	redo
copyString	resample
createDir	runScript
createSceneScript	scriptExists
deleteFile	setActiveTake
deleteScriptPath	setAltToSelect
exit	setAutoSaveFile
formatTime	setBackupPlfsEnabled
frameToSmpte	setControlToManipulate
getActiveTake	setDir
getAutoSaveFile	setErrorHandler
getClipboardText	setExitCode
getDirList	setFrameRate
getFileExtension	setHotKey
getFileList	setHotKeyFile
getFileLocation	setLanguage
getFileName	setLogEnabled
getFileTitle	setLogFile
getGlobalVarExists	setMarkingMenuFile
getLastScript	setSavePath
getProfileInt	setSceneName
getProfileString	setScriptPaths
getSavePath	setSelectionSetFile
getSceneName	setTimeFormat
getSceneUpAxis	smpteToFrame
getScriptPaths	sortFloats
getSystemTime	sortInts
getTimecodeStandard	sortStrings
help	system
listCommands	undo
listObjectTypes	undoConsolidated
markingMenu	writeProfileInt
pathExists	writeProfileString

Testing commands

Use the commands in this category for testing purposes.

Testing commands
compareModules	testPrint
compareXMLFiles

User window commands

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
createDropList	getTabItem
createForm	getTabSelItem
createGroupBox	getTimeBoxTime
createListBox	getTopLevelForm
createListView	getWindowRect
createNumBox	getWindowVisibility
createPushButton	layoutForm
createRadioButton	selectDropListItem
createStaticBox	selectListBoxItem
createTab	selectListViewItem
createTextBox	selectTabItem
createTimeBox	setCheckBoxCheck
createWindow	setCheckBoxHandler
deleteAllDropListItems	setColorPickerColor
deleteAllListBoxItems	setColorPickerHandler
deleteAllListViewItems	setControlAnchor
deleteAllTabItems	setControlPos
deleteDropListItem	setControlText
deleteListBoxItem	setControlTip
deleteListViewItem	setDropListHandler
deleteTabItem	setFocus
destroyWindow	setListBoxHandler
dirChooser	setListViewColumns
enableControl	setListViewHandler
fileChooser	setListViewItemCheck
findDropListItem	setListViewItemText
findListBoxItem	setNumBoxHandler
findTabItem	setNumBoxNum
getCheckBoxCheck	setNumBoxRange
getColorPickerColor	setPushButtonHandler
getControlEnabled	setRadioButtonCheck
getControlPos	setRadioButtonHandler
getControlText	setStaticBoxHandler
getControlVisibility	setTabHandler
getDropListItem	setTextBoxHandler
getDropListSelItem	setTimeBoxHandler
getFocus	setTimeBoxTime
getListBoxItem	setWindowHandler
getListBoxSelItems	showControl
getListViewItemCheck	showWindow
getListViewItemText	windowExists
getListViewSelItems

Browser not supported