Chapter 3 · Modifier Properties

3.19Tnpix_Wrap

Panel name Tnpix Wrap · also reachable as TnpixWrap

Makes a high-resolution mesh follow low-resolution proxies. TnpixTool.wrapFill and wrapInfo are its script functions.

Property Type A Default Range Description

tnEnabled boolean true On/off.

proxies node array empty The low-resolution meshes that drive this one.

bindFrame integer 0 -100,000 – 100,000 The frame where the mesh and the proxies line up.

smoothing float 1.0 0.0 – 4.0 Blend reach over neighbouring proxy faces, in proxy edge lengths; 0 = one face.

falloff float 1.0 0.1 – 10.0 How fast a neighbouring face's influence fades; 1 = even.

offset float A 1.0 0.0 – 1.0 Fraction of its height above the proxy a point keeps.

strength float A 1.0 0.0 – 1.0 How far points move to where the wrap puts them; 1 = fully.

weightFrom integer 0 Where per-point strength comes from: 0 = Everywhere, 1 = Vertex color, 2 = Tnpix channel.

weightChannel string "" The Tnpix channel that scales the strength, by name.

limitDistance boolean false true = points farther than maxDistance from every proxy are left alone.

maxDistance float 1.0 0.0 – 1,000,000 Scene units, measured at the bind frame.

cutTears boolean true Cut this mesh along proxy tears.

rememberProxies boolean true Keep each proxy's shape per frame in memory. No limit: every frame seen stays until the scene closes, about 12 bytes per proxy point per frame.

closeCuts boolean true Where this mesh is a shell (two layers), close each cut along a proxy tear with a strip of faces. Works with cutTears on; a one-layer mesh is left as it is.

rimMaterialID integer 0 0 – 65,535 Material ID of the faces that close the cuts; 0 = the ID of the outer face beside each one.

Property	Type	A	Default	Range	Description
`tnEnabled`	boolean		true		On/off.
`proxies`	node array		empty		The low-resolution meshes that drive this one.
`bindFrame`	integer		0	-100,000 – 100,000	The frame where the mesh and the proxies line up.
`smoothing`	float		1.0	0.0 – 4.0	Blend reach over neighbouring proxy faces, in proxy edge lengths; 0 = one face.
`falloff`	float		1.0	0.1 – 10.0	How fast a neighbouring face's influence fades; 1 = even.
`offset`	float	A	1.0	0.0 – 1.0	Fraction of its height above the proxy a point keeps.
`strength`	float	A	1.0	0.0 – 1.0	How far points move to where the wrap puts them; 1 = fully.
`weightFrom`	integer		0		Where per-point strength comes from: 0 = Everywhere, 1 = Vertex color, 2 = Tnpix channel.
`weightChannel`	string		""		The Tnpix channel that scales the strength, by name.
`limitDistance`	boolean		false		true = points farther than `maxDistance` from every proxy are left alone.
`maxDistance`	float		1.0	0.0 – 1,000,000	Scene units, measured at the bind frame.
`cutTears`	boolean		true		Cut this mesh along proxy tears.
`rememberProxies`	boolean		true		Keep each proxy's shape per frame in memory. No limit: every frame seen stays until the scene closes, about 12 bytes per proxy point per frame.
`closeCuts`	boolean		true		Where this mesh is a shell (two layers), close each cut along a proxy tear with a strip of faces. Works with `cutTears` on; a one-layer mesh is left as it is.
`rimMaterialID`	integer		0	0 – 65,535	Material ID of the faces that close the cuts; 0 = the ID of the outer face beside each one.