This information is for Vicon Shogun 1.7. For up-to-date help, see the latest Shogun documentation.

Vicon Shogun banner

Description

Creates a constraint between a module (typically a marker) and a bone. Also automatically adds parameters for the constraint offset to the constraint.

Used when setting up a skeleton to be solved, retargeted or creating a VST.

The createSkelScript command uses the attach command to create constraints when the -solvers flag is used.

Functional area

Skeletal solving

Command syntax

Syntax

attach "targetBone" "module1" "module2"... [-parent] [-retargetingRotation]

Arguments

NameTypeRequiredComments
targetBoneStringyesName of the Bone the Modules should be attached to.
module1StringyesName of a Module to attach to the bone.
marker2StringnoName of another Module to attach to the bone.

Flags

NameFlag argumentsArgument typeExclusive toComments
parent1string
retargetingRotation



Return value

void

Examples

// Create a Bone and a Marker
create BoneNode "root";
create Marker "marker1";

// Attach the marker to the bone resulting in a new constraint.
attach root marker1;
// Create position and rotation targets
attach mySubject\\Retargeting\\pelvis mySubject\\Solving\\Hips;
attach mySubject\\Retargeting\\pelvis mySubject\\Solving\\Hips -retargetingRotation;

 Download a complete example script for creating position and rotation targets for the MannequinFingers skeleton.

Additional information

Related commands