Chapter 3 · Modifier Properties

3.14Tnpix_Volume

Panel name Tnpix Volume · also reachable as TnpixVolume

Gives a closed shell an inside. Per object. Keyed values drive one continuous simulation.

Property Type A Default Range Description

tnEnabled boolean true On/off.

mode integer 0 0 – 1 0 = Keep volume, 1 = Pressure.

volumeRatio float A 1.0 0.05 – 10.0 Target as a fraction of the rest volume.

softness float 0.0 0.0 – 1.0 0 holds the volume exactly; higher lets contact squash the shape.

pressure float A 0.0 -10.0 – 10.0 Pressure mode: a constant push outward, in scene units per solver step; negative pulls in.

restFrame integer 0 -100,000 – 100,000 The frame whose shape is the rest volume; 0 is the first simulated frame, wherever the timeline starts.

buoyancy boolean A false Lifts the closed shape as if it were lighter than air. A whole object only: not used while volumeChannel names a channel.

lift float A 1.0 0.0 – 3.0 Buoyancy strength: 1 hovers, above 1 rises.

volumeChannel string "" The painted channel this Volume holds. "" = the whole closed object; a channel name = only the painted area, each point as firmly as its paint. Above a Tnpix_Pin or Tnpix_Preserve on the stack, its painted points are let go from them.

volumeCentre node undefined The centre a region's volume is measured against. undefined = the middle of its painted points; a node = that object (a bone or helper inside the region). The cloth itself is refused.

restFrameOn boolean true true = the rest volume is the shape at restFrame; false = no rest frame: the volume follows the shape below the Solver on every frame, read through a Tnpix Wrap below it, times volumeRatio.

Property	Type	A	Default	Range	Description
`tnEnabled`	boolean		true		On/off.
`mode`	integer		0	0 – 1	0 = Keep volume, 1 = Pressure.
`volumeRatio`	float	A	1.0	0.05 – 10.0	Target as a fraction of the rest volume.
`softness`	float		0.0	0.0 – 1.0	0 holds the volume exactly; higher lets contact squash the shape.
`pressure`	float	A	0.0	-10.0 – 10.0	Pressure mode: a constant push outward, in scene units per solver step; negative pulls in.
`restFrame`	integer		0	-100,000 – 100,000	The frame whose shape is the rest volume; 0 is the first simulated frame, wherever the timeline starts.
`buoyancy`	boolean	A	false		Lifts the closed shape as if it were lighter than air. A whole object only: not used while `volumeChannel` names a channel.
`lift`	float	A	1.0	0.0 – 3.0	Buoyancy strength: 1 hovers, above 1 rises.
`volumeChannel`	string		""		The painted channel this Volume holds. `""` = the whole closed object; a channel name = only the painted area, each point as firmly as its paint. Above a `Tnpix_Pin` or `Tnpix_Preserve` on the stack, its painted points are let go from them.
`volumeCentre`	node		undefined		The centre a region's volume is measured against. `undefined` = the middle of its painted points; a node = that object (a bone or helper inside the region). The cloth itself is refused.
`restFrameOn`	boolean		true		true = the rest volume is the shape at `restFrame`; false = no rest frame: the volume follows the shape below the Solver on every frame, read through a Tnpix Wrap below it, times `volumeRatio`.