Vicon Shogun banner

Description

Retrieves an array of Boolean values from a object's attributes.

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 mainly used to retrieve the DOF (Degrees of Freedom) attribute. A six element Boolean array is returned. DOFs that are turned on will have "true" array values.

Functional area

Data retrieval

Command syntax

Syntax

getBooleanArrayProperty moduleName propertyName

Arguments

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

Flags

None

Return value

boolean array

Examples

// Get the DOFs of the "thorax" bone.
boolean $dofs[];
$dofs = `getBooleanArrayProperty "thorax" "DOF"`;
print $dofs;

Additional information

Related commands