The Gas Field VOP operation runs CVEX over a set of fields. The CVEX shader can be defined as a .vfl file, a Shop, or by building a CVEX VOP network inside this node. The last is the most straightforward approach.
Binding to the CVEX script controls what values are passed to which parameters of the script. The default AutoBind will use the name of the fields to determine which parameter they should override. If that parameter is marked as exported in the CVEX script, the field will be written to. Otherwise, the field is just read to get the parameter’s values.
The CVEX script is applied once for each exported field.
P bindings are
created that refer to the index, resolution, center, and current voxel
position of the currently exported primitive.
The parameters list starts with parameters created by the CVEX script’s parameters. If the parameter is meant only to be bound to a field, it can be hidden by setting the invisible flag on the VOP parameter.
Where to get the CVEX script from. Myself will refer to the VOP network built inside this node. SHOP will use the Shop Path and Script will load the .vex file specified in the script.
The CVEX Shop to apply.
This can also point to any node that contains a CVEX VOP Network.
Referenced nodes parameters will be used.
The CVEX script to apply.
Re-load VEX Functions
When in script mode, this reloads any .vex files to account for updates made outside of Houdini.
The command line used by VOPs to compile the inside of this node.
Trigger a recompile of the VOP network.
Evaluation Node Path
VEX functions like
ch() usually evaluate with respect to this node.
Providing a path here can override where the path search starts
from. This is useful for embedding in a digital asset where you
would like the top level digital asset to be the search root.
This pattern can be used to override the export option on the VEX shader to avoid writing to certain fields. The pattern matches the VEX parameter, not the bound field. The field will still be bound for reading.
Autobind by Name
Will use the name of the field to determine which field binds with which parameter.
A scalar field named “foo” will be bound to the float parameter “foo”. A vector field “foo” will be bound to the vector (three float) parameter “foo”. A matrix field “foo” will be bound to the matrix (three by three) parameter “foo”. An index field named “foo” will be bound to the integer parameter “foo”.
Manually specifies the bindings of each field.
A scalar field to use as a stencil for where to evaluate the VOP network. Voxels that are strictly greater than 0.5 will be run through the VOP network, others will be left unchanged.
VEX can evaluate at 32-bit or 64-bit precision. 64-bit provides higher accuracy, especially for transforms.
The auto mode will currently run in 32-bit mode as fields are always 32-bit.
Input 1, 2, 3, 4
These control the four virtual inputs accessible inside of VOPs.
They can be accessed with the OpInput1-4 wires from the VOP, or with
@OpInput1-4 string parameters when using VEXpressions.
They can also be accessed numerically as 0-3 with VEX functions that take an input number.
No geometry is wired to this input.
The SOP geometry will be cooked prior to running the VEX and the result wired to this input.
Data in the current simulation to reference. Specified as
an object/data, for example,
pyro1/vel to refer to the velocity
field of the
pyro1 object (which will show up as three volume
Nth Context Geometry
These refer to the SOPs wired into the parent DOP Network itself.
Path to a SOP to wire in.
Object/data path of a piece of DOP data in THIS simulation to wire in. If Use This Object’s Data is enabled, this specifies the data path for data attached to the currently solved object.
Use This Object’s Data
When enabled, the DOP Data specifies the name of data attached to the currently solved object.
This is usually equivalent to
$OBJID/DataName, but using
$OBJID requires one to set the Solver Per Object toggle which prevents mutual affectors from working with solvers such as RBD.
If the referenced data is the geometry being currently processed, a copy is made (similar to the Myself binding option).
Determines if the current solver timestep will be used to apply this node.
If set, the current timestep size will be multiplied by the scale and used for the time increment for this operation. Otherwise, the time scale will specify an absolute fictitious time to integrate by.
By disabling the link between the actual real time and the microsolver time, you can perform operations in a separate, fictitious, time.
The timestep used for this microsolver will be scaled by this amount. This allows one to achieve non-realistic effects, such as parts of the simulation operating at different speeds than other parts.
Similarly, it is useful if a solver needs to be evaluated independently of the main timestep.
Each data option parameter has an associated menu which specifies how that parameter operates.
Use the value from the Default Operation menu.
Set the value of this parameter only when this data is created. On all subsequent timesteps, the value of this parameter is not altered. This is useful for setting up initial conditions like position and velocity.
Always set the value of this parameter. This is useful when specific keyframed values are required over time. This could be used to keyframe the position of an object over time, or to cause the geometry from a SOP to be refetched at each timestep if the geometry is deforming.
You can also use this setting in
conjunction with the local variables for a parameter value to
modify a value over time. For example, in the X Position, an
$tx + 0.1 would cause the object to
move 0.1 units to the right on each timestep.
Do not ever set the value of this parameter. This option is most useful when using this node to modify an existing piece of data connected through the first input.
For example, an RBD State DOP may want to animate just the mass of an object, and nothing else. The Set Never option could be used on all parameters except for Mass, which would use Set Always.
For any parameters with their Operation menu set to Use Default, this parameter controls what operation is used.
This parameter has the same menu options and meanings as the Parameter Operations menus, but without the Use Default choice.
Make Objects Mutual Affectors
All objects connected to the first input of this node become mutual affectors.
This is equivalent to using an Affector
DOP to create an affector relationship between
* before connecting it to this node. This option makes it
convenient to have all objects feeding into a solver node affect
When an object connector is attached to the first input of this node, this parameter can be used to choose a subset of those objects to be affected by this node.
Indicates the name that should be used to attach the data to an object or other piece of data. If the Data Name contains a “/” (or several), that indicates traversing inside subdata.
For example, if the Fan Force DOP has the default Data Name “Forces/Fan”. This attaches the data with the name “Fan” to an existing piece of data named “Forces”. If no data named “Forces” exists, a simple piece of container data is created to hold the “Fan” subdata.
Different pieces of data have different requirements on what names should be used for them. Except in very rare situations, the default value should be used. Some exceptions are described with particular pieces of data or with solvers that make use of some particular type of data.
Unique Data Name
Turning on this parameter modifies the Data Name parameter value to ensure that the data created by this node is attached with a unique name so it will not overwrite any existing data.
With this parameter turned off, attaching two pieces of data with the same name will cause the second one to replace the first. There are situations where each type of behavior is desirable.
If an object needs to have several Fan Forces blowing on it, it is much easier to use the Unique Data Name feature to ensure that each fan does not overwrite a previous fan rather than trying to change the Data Name of each fan individually to avoid conflicts.
Solver Per Object
The default behavior for solvers is to attach the exact same solver to all
of the objects specified in the group. This allows the objects to be
processed in a single pass by the solver, since the parameters are identical
for each object. However, some objects operate more logically on a single
object at a time. In these cases, one may want to use
to vary the solver parameters across the objects. Setting this toggle will
create a separate solver per object, allowing
$OBJID to vary as expected.