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

Name	Type	Required	Comments
`targetBone`	String	yes	Name of the Bone the Modules should be attached to.
`module1`	String	yes	Name of a Module to attach to the bone.
`marker2`	String	no	Name of another Module to attach to the bone.

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`parent`	1	string	—	—
`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.

A complete example script for creating position and rotation targets for the MannequinFingers skeleton is available from the 'attach' page in the online version of the HSL scripting with Vicon Shogun at docs.vicon.com.

Additional information

Related commands

createSkelScript