Vicon Shogun banner

Description

Returns the value of the named property on the named module at the current time.

The getProperty command is useful in script procedures for automatically identifying the value of the property of a module. The called properties can be in either the Attributes or Channels panels.

The results may be saved to a variable, which may in turn be passed to a subsequent command or procedure.

Functional area

Data retrieval

Command syntax

Syntax

getProperty moduleName propertyName[-c] [-d]

Arguments

NameTypeRequiredComments
moduleName
propertyName


The arguments consist of a module name and any property name that applies for that module type.

Flags

NameFlag argumentsArgument typeExclusive toComments
c0
d0

Return value

float

Examples

float $loc = `getProperty RBWT "TranslationX"`;
print $loc;
// Identifies the X position of the marker object RBWT and
// saves the XYZ values to a float variable called "$loc".
float $wt = `getProperty RUPA "Weight"`;
print $wt;
// Returns the weight of the RUPA to a floating
// point variable $wt.

Additional information

Related commands