Chapter 4 · The TnpixTool Interface

4.9Threads

index counts the node's Tnpix Threads modifiers from the top of the stack, starting at 1 (not 0 as elsewhere in this chapter). The forms without index address the top-most Tnpix Threads.

Function Returns What it does

threadsInfo node string The status lines of the Tnpix Threads on this frame, as the panel shows them. (no Tnpix Threads on this node) when there is none.

threadsInfoAt node index string The same for the index-th Tnpix Threads.

threadsMakeObject node string Make the threads object: creates the Tnpix Threads Object that shows these threads, sets Tubes go to their own object, and returns the new object's name. A line beginning *** says why it refused, for example when an object already shows these threads.

threadsMakeObjectAt node index string The same for the index-th Tnpix Threads.

Function	Returns	What it does
`threadsInfo node`	string	The status lines of the Tnpix Threads on this frame, as the panel shows them. (no Tnpix Threads on this node) when there is none.
`threadsInfoAt node index`	string	The same for the index-th Tnpix Threads.
`threadsMakeObject node`	string	Make the threads object: creates the Tnpix Threads Object that shows these threads, sets Tubes go to their own object, and returns the new object's name. A line beginning *** says why it refused, for example when an object already shows these threads.
`threadsMakeObjectAt node index`	string	The same for the index-th Tnpix Threads.

addModifier $Sheet (Tnpix_Threads())     -- on top, above the Solver
$Sheet.modifiers[#Tnpix_Threads].warpEvery = 0.1
TnpixTool.sim $Sheet 30                   -- simulate up to frame 30
TnpixTool.threadsInfo $Sheet
TnpixTool.threadsMakeObject $Sheet        -- returns "Sheet_Threads"