Vicon Shogun banner

Description

Retrieves a string array of the names of the bone nodes that a solver is acting on.

For a specified solver, this script returns an array containing the names (including paths, if desired) of the bone nodes that the solver is associated with.

The default format for each bone node is to provide the minimum path (top level node and the name of the bone), but the full path or just the name only can be specified.

Functional area

Data retrieval

Command syntax

Syntax

getSolverBones solverName[-fullPath] [-nameOnly]

Arguments

NameTypeRequiredComments
solverNamestringyesSolver to retrieve list of BoneNodes for.

Flags

NameFlag argumentsArgument typeExclusive toComments
fullPath0nameOnlySet this flag to fill each string in the array with the full path to the bone
nameOnly0fullPathSet this flag to fill each string in the array with only the name of the bone

Return value

string array
(A string array containing the names and/or paths of the bone nodes associated with the solver)

Examples

// Get the BoneNodes a Solver the chest solver is acting on.
string $bones[];
$bones = `getSolverBones "chest_solver"`;
print $bones;

Additional information

Related commands