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

Vicon Shogun banner


Positions the given node along the line formed by two selected nodes.

With two nodes that define a line select, snapToLine positions the targetNodeName along that line. Where along the line is specified as a percentage of the distance between the two nodes making up the line unless the -absolute option is used. When -absolute is used the distance along the line is specified in mm.

Functional area


Command syntax


snapToLine "targetNodeName" %s [-allTime] [-absolute] [-ranges]


targetNodeNamestringyesSpecifies the name of the node to be snapped.
%sfloatyesSpecifies distance along the line the node should be snapped to.


NameFlag argumentsArgument typeExclusive toComments
allTime0rangesPerforms the snap over the entire animation range.
absolute0Specifies the argument is in mm rather then a percentage of the distance between the two nodes that define the line.
ranges0allTimePerforms the snap over the selected time ranges.

Return value



// Snap LMWT half way between LFWT and LBWT at the current frame only.
select LFWT LBWT;
snapToLine LMWT 0.5;

Additional information

Related commands