SBM Command Line
From smartbody
Contents |
SBM Command Line
Here is a list of supported command line arguments used to configure a SBM process.
This table covers the most common arguments.
| -seq | Runs a .seq file at startup. |
| -seqpath | Appends a directory to the seq path. |
| -mepath | Appends a directory to the me path. |
| -host | Identifies a BoneBus rendering server. |
| -audio | Enables internal PlaySound processing. |
| -fps | Sets the maximum frame rate. |
-audio
Enables internal processing of PlaySound commands using the linked SDL Media libraries.
sbm-fltk.exe -audio
-facebone
Enables output of face bone animation (everything above the skullbase joint, excluding the eyes) over BoneBus.
sbm-fltk.exe -facebone
This is a test configuration as we complete the controller pipeline to make this standard.
-fps=<framerate>
Sets the maximum frame rate for animation evaluation, CommAPI updates, and internal viewer rendering, where <framerate> is an integer of frames per second.
sbm-fltk.exe -fps=100
If omitted, the SBM process will run as fast a possible. If the system is loaded enough to run slower, then this parameter has no effect.
Clarification: How does this interact with the vsync lock if the internal viewer is opened? [user:amarshal 1209918817]
-host=<machine-id>
Identifies the host for the BoneBus server, where <machine-id> is either the IP address or hostname.
sbm-fltk.exe -host=localhost
If omitted, SBM animation data will not be exported, but will still be viewable using the internal viewer.
-lockdt
Used in combination with -fps to lock the simulated evaluation frame rate, regardless of the real performance.
sbm-fltk.exe -fps=30 -lockdt
This is useful for recording animation data to file for later playback, or testing unoptimized controllers.
-mepath <directory>
Appends <directory> to the me ("Motion Engine") path, where .sk skeleton files may be loaded.
sbm-fltk.exe -mepath ..\..\..\..\data\sbm-testdata\doctor
Multiple -mepath entries can be provided, each prefixed by a -mepath argument. Paths are searched in the order specified at the command line, with paths specified at the SBM shell or in .seq files searched afterward. Technically, each entry
See Also: the path me command.
-procid <id>
Sets the SBM process identifier used by the sbm command, where <id> is a unique identifier token (no whitespace).
sbm-fltk.exe -procid Sbm007
This allows commands to be directed to one of multiple concurrent sbm processes in a distributed environment.
-perf=<interval>
Sets the performance reporting interval, and enables frame-rate output at the console.
sbm-fltk.exe -perf=10
If -lockdt is set, both real and simulated dt and fps are reported.
Clarification: Is interval in frames or seconds? [user:amarshal 1209919529]
-seq <sequence>
Runs a sequence at start-up, where <sequence> is the filename or .seq file basename from the seqpath directories.
sbm-fltk.exe -seq demo
Multiple -seq commands can be chained, to invoke multiple seq files:
sbm-fltk.exe -seq demo -seq sbm-camera-init.seq
All sequences will be started at time zero. If commands are scheduled at the same time, the commands from the first seq file listed will be processed first.
If -seq is omitted, SBM will automatically attempt to run default.seq.
See Also: the seq command.
-seqpath <directory>
Appends the <directory> to the seq ("sequence") path, where .seq sequence files may be loaded.
sbm-fltk.exe -seqpath ..\..\..\..\data\sbm-testdata
Multiple -seqpath entries can be provided, each prefixed by a -seqpath argument. Paths are searched in the order specified at the command line, with paths specified at the SBM shell or in .seq files searched afterward.
If no -seqpath argument is provided, the current working directory is automatically added to the seq path.
See Also: the path seq command.
