OOF2: The Manual

Name

OOF.Graphics_n.Toolbox.Pin_Nodes.TogglePin — Toggle the pinnedness of the node closest to the given point.

Synopsis

OOF.Graphics_n.Toolbox.Pin_Nodes.TogglePin(skeleton,point)

Details

  • Parent Menu: OOF.Graphics_n.Toolbox.Pin_Nodes
  • Callback: function PinnedNodesToolbox.togglepin in module ooflib.engine.IO.pinnodes
  • Parameters:

    skeleton
    Type: The path to an existing Skeleton object.
    point
    Target point. Type: A Point object (eg, Point(1.1, 2.0)).

Description

The TogglePin command is called by the Pin Nodes toolbox in the graphics window. It toggles whether or not a Node is pinned. TogglePin operates on the Skeleton given as an argument. When run from the graphics window, this will be the topmost Skeleton displayed in the window.

The skeleton parameter is the fully-qualified name of the Skeleton on which to operate.

The point parameter is the position at which the mouse was clicked. The Skeleton Node closest to the mouse click will be pinned or unpinned.