Description

Snaps a named node to the position and rotation defined by the local coordinate system of the selected node.

The snapToLocal command differs from snapToSystem, snapToSystemAlign, and snapToRigid in that snapToLocal only requires one node be selected to define the coordinate system.

Functional area

Snap

Command syntax

Syntax

snapToLocal "targetNodeName" offsetX offsetY offsetZ [-allTime] [-positionOnly] [-rotationOnly] [-ranges]

Arguments

Name	Type	Required	Comments
`zOffset`	float	yes	Specifies the position offset to apply to the object being snapped on the Z axis of the space defined by the selected markers.
`yOffset`	float	yes	Specifies the position offset to apply to the object being snapped on the Y axis of the space defined by the selected markers.
`xOffset`	float	yes	Specifies the position offset to apply to the object being snapped on the X axis of the space defined by the selected markers.
`targetNodeName`	string	yes	Name of the node that will be snapped.

Flags

Name	Argument type	Exclusive to	Comments
`all time`	—	ranges	Performs the snap over the entire animation range.
`positionOnly`	—	rotationOnly	Only modifies the position of the node being snapped.
`rotationOnly`	—	positionOnly	Only modifies the rotation of the node being snapped.
`absolute`	—	—	Specifies the offset is in mm rather then a percentage of the distance between the first two nodes that define the system.
`ranges`	—	allTime	Performs the snap over the selected time ranges.

Return value

void

Examples

// Create a marker and set its translation and rotation in space 
// then create a second marker and snap it relative to the first
// markers system.
create Marker "marker1";
setProperty Translation 200 0 200 -d ;
setProperty Rotation 0 45 45 -d;
create Marker "marker2";
select marker1;
snapToLocal "marker2" 100 100 100;

Shogun 1.10 Documentation

snapToLocal