Chapter 3 · Modifier Properties

3.10Tnpix_Pin

Panel name Tnpix Pin · also reachable as TnpixPin

Holds a painted region in place or on an object. TnpixTool.pinSet sets channel, weight and object in one undoable call.

Property Type A Default Range Description

tnEnabled boolean true On/off.

channel string "" The painted channel this pin holds; empty = holds nothing. A Tnpix_Soft_Body or Tnpix_Volume with a channel above the pin on the stack lets go of the points it paints.

weight float A 1.0 0.0 – 1.0 The follow fraction: 1 = follows 100 percent, 0.5 = 50 percent. Below 1 is a soft pin.

followObject node undefined The object the pinned points follow; undefined = held in place.

activeTime boolean false true = the pin holds only from activeFrom to activeTo.

activeFrom integer 0 -100,000 – 100,000 First frame the pin holds.

activeTo integer 100 -100,000 – 100,000 Last frame the pin holds; before activeFrom the pin never activates.

reach float 0.0 0.0 – 1,000,000 Scene units: painted points farther than this from the object when the pin takes hold stay free. 0 = any distance.

minPiece float 1.0 0.0 – 100.0 Percent of the cloth's faces: a torn piece smaller than this lets go of the pin. 0 = never.

dynamic boolean false true = the pinned points keep their mass and the pin pulls them; false = the object moves them directly.

zoneOn boolean false Active Zone: the pin holds a painted point only while the zone reaches it, with its weight times the zone's value there. Works inside the Active time.

zoneHelpers node array empty The Influence Helpers that make the zone. Empty with zoneOn = the pin holds nothing.

zoneStay boolean false Stays held once touched: a point the zone has reached stays held until the Active time ends. false (the default) = only the points inside the zone now.

zoneInvert boolean false Invert: the pin holds where the zone does NOT reach (its weight times one minus the zone's value). With zoneStay, a point the helper has touched stays let go. Empty zoneHelpers = every painted point is held.

Property	Type	A	Default	Range	Description
`tnEnabled`	boolean		true		On/off.
`channel`	string		""		The painted channel this pin holds; empty = holds nothing. A `Tnpix_Soft_Body` or `Tnpix_Volume` with a channel above the pin on the stack lets go of the points it paints.
`weight`	float	A	1.0	0.0 – 1.0	The follow fraction: 1 = follows 100 percent, 0.5 = 50 percent. Below 1 is a soft pin.
`followObject`	node		undefined		The object the pinned points follow; `undefined` = held in place.
`activeTime`	boolean		false		true = the pin holds only from `activeFrom` to `activeTo`.
`activeFrom`	integer		0	-100,000 – 100,000	First frame the pin holds.
`activeTo`	integer		100	-100,000 – 100,000	Last frame the pin holds; before `activeFrom` the pin never activates.
`reach`	float		0.0	0.0 – 1,000,000	Scene units: painted points farther than this from the object when the pin takes hold stay free. 0 = any distance.
`minPiece`	float		1.0	0.0 – 100.0	Percent of the cloth's faces: a torn piece smaller than this lets go of the pin. 0 = never.
`dynamic`	boolean		false		true = the pinned points keep their mass and the pin pulls them; false = the object moves them directly.
`zoneOn`	boolean		false		Active Zone: the pin holds a painted point only while the zone reaches it, with its weight times the zone's value there. Works inside the Active time.
`zoneHelpers`	node array		empty		The Influence Helpers that make the zone. Empty with `zoneOn` = the pin holds nothing.
`zoneStay`	boolean		false		Stays held once touched: a point the zone has reached stays held until the Active time ends. false (the default) = only the points inside the zone now.
`zoneInvert`	boolean		false		Invert: the pin holds where the zone does NOT reach (its weight times one minus the zone's value). With `zoneStay`, a point the helper has touched stays let go. Empty `zoneHelpers` = every painted point is held.