Description

Summary

Sets the file export options for the BVH file format.

Details

BVH is a skeleton animation file format. The format holds the skeleton definition and animation data for a given trail. A BVH file can only contain one character hierarchy and will not allow local transforms in the base pose.

Functional area

File handling

Command syntax

Syntax

bvhExportOptions [-writeDofs boolean] [-padStartFrames boolean] [-upAxis string] [-rotateToFacePositive boolean] [-unscaleRetargeting boolean]

Arguments

None

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`writeDofs`	1	boolean	—	Ensures that any active bone node will contain all three degrees of freedom even if the bone was solved with just one or two DOFs active.
`padStartFrames`	1	boolean	—	Creates zero value frames of data until the first frame of data specified in Shogun. For instance, if the Shogun scene starts at frame 60, using this option will insert 59 blank frames into the BVH file. This option is useful if you are trying to ensure temporal (or time) relationship between a BVH file and other files or environments that maintain explicit frame ranges.
`upAxis`		string	—	Valid values are `Y`, `Z`, or `Scene` (not case sensitive).
`rotateToFacePositive`		boolean	—	If true, Rotate to face positive is selected and the motion will be rotated 180° about the new Up axis to ensure that after up axis conversion, motion which started facing positive is still facing positive. If false, it is cleared.
`unscaleRetargeting`		boolean	—	Specifies if the option to unscale retargeting in BVH export is on or off. Unscale retargeting is on (checked) if true, or off (cleared) if false.

Return value

void

Examples

//set the BVH export to write all rotation DOFs and pad with 
// zeros up to the start frame. 
bvhExportOptions –writeDofs true –padStartFrames true;

Shogun 1.12 Documentation

bvhExportOptions