Vicon Shogun banner

Description

Retrieves a vector value from an object.

Because Shogun Post commands can only have one return type, there must be separate commands for retrieving different types of property data.

This command is used to retrieve channel or attributes values that are vectors or rotations (e.g. the translation channel or Local_Axis_Offset).

If propertyName represents a channel, the channel value at the current time is returned, unless the -c option is specified.

Functional area

Data retrieval

Command syntax

Syntax

getVectorProperty moduleName propertyName[-c] [-d]

Arguments

NameTypeRequiredComments
propertyNamestringyesName of the property on the object.
moduleNamestringyesObject to retrieve property value from.

Flags

NameFlag argumentsArgument typeExclusive toComments
c0Retrieves the property's const value. Only has an effect if propertyName represents a channel (i.e. can be animated).
d0

Return value

vector

Examples

// Get some information about the "thorax" bone.
vector$constTrans;
vector$offsetRot;
//Get the Translation values of the thorax constants.
$constTrans = `getVectorProperty "thorax" "Translation" -c`;
print $constTrans;
// Get the local axis offset.
$offsetRot = `getVectorProperty "thorax" "Local_Axis_Offset"`;
print $offsetRot;

Additional information

Related commands