|On this page|
This is a very powerful, low-level node that lets experts who are familiar with VEX tweak attributes using code.
This node corresponds to the Geometry VOP DOP, but uses a textual VEX snippet instead of a VOP network.
This node requires that you understand the vex language. It is very easy to write incorrect code using this node.
This node runs the snippet on the detail or every point/primitive/vertex (depending on the Run Over parameter) in the input geometry. The snippet can edit the input geometry by changing attributes. It can access information from other geometry using attributes and VEX functions.
Press on the node to see any error output from the snippet.
You can use the VEX function
chto evaluate parameters. The path is relative to this node (
ch("parm")will evaluate the parameter
parmon this node). This evaluation will be done at the current time.
Unlike the Attrib Create SOP, this does not use local variables. Further, all backtick expressions and
$Fvariables will be evaluated at frame 1, not the current time. Use
A subset of points in the input geometry to run the program on. Leave this blank to affect all points in the input. The type of group must match the Run Over parameter.
What class of geometry attributes to modify. No attributes will be bound, except read-only detail attributes, when set to Numbers.
Iteration count when Run Over is set to Numbers.
@elemnum will be the iteration number from 0 (inclusive), to this number (exclusive),
@numelem will be this number.
No attributes will be bound when in this mode, except read-only detail attributes.
Thread Job Size
Maximum number of iterations run at a time in any thread when Run Over is set to Numbers. If this is greater than or equal to Number Count, the VEX code will run single-threaded. If each iteration will take a very large amount of time, set this to 1. However, there is quite often a significant advantage to making this value larger, especially if each iteration will take a small amount of time, and if any work can avoid being duplicated by running multiple iterations at a time.
A snippet of VEX code that will manipulate the point attributes.
You can use
@variable_name syntax to access geometry attributes.
Attributes to Create
Only create attributes if their names match this pattern. The default pattern allows any attribute to be created.
You can restrict the created attributes by replacing the
* with a list of allowed names.
Bound attributes, such as
vtxnum, cannot be created and will be ignored.
Requires that you declare
@ bindings in snippets as prototypes before using them. This applies to both attributes (for example
@Cd) and "convenience" bindings such as
@Frame. For example:
// Declare bindings int @ptnum; float @Frame; vector @Cd; // Use bindings after declaration int pointnum = @ptnum; float red = @Cd / @Frame;
Automatic binding with the
@ syntax can be convenient, but as your scene becomes more complex there is the risk that a typo in an
@ binding will silently just bind a non-existent attribute.
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.
The list of the geometry on the object to process.
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.
An overall scale applied to the actual timestep.
When a VEX parameter is exported, the bound attribute will be created if it doesn’t exist. This pattern can be used to override the export option on the VEX shader to avoid writing to or creating certain attributes. The pattern matches the VEX parameter, not the bound attribute. The attribute will still be bound for reading.
Autobind by Name
Will use the name of the attribute to determine which attribute binds with which parameter.
Integer attributes will bind to integer parameters. Float attributes will bind to float, vector, point, matrix, or matrix4 depending on their tuple size. String attributes will bind to strings.
Attribute Name, VEX Parameter
Manually specifies the bindings of each attribute.
Field Name, VEX Parameter
Optionally binds Scalar, Vector, Matrix, or Index fields from this
object to the CVEX function. They will be sampled at the current
location of each element.
You can then access these with the @ syntax referring to the given Parameter.
Autobind Groups by Name
Automatically bind any groups to the integer parameter prefixed with
Group Name, VEX Parameter
Manually specifies the bindings of each group.
Update Normals If Displaced
If points are being run over, and the
P attribute is written to,
N attribute is not written to, any incoming normals will
become out of date. When this option is set, vertex and point
normals will be updated when this occurs.
VEX can evaluate at 32-bit or 64-bit precision. 64-bit provides higher accuracy, especially for transforms.
Incoming attributes will preserve their original precision, so using 64-bit VEX on 32-bit positions will convert them to 64-bit, apply the operation, then convert back to 32-bit when writing out.
The auto mode will switch between 32-bit and 64-bit depending on the preferred precision of the incoming geometry. When run in 64-bit precision, any created attributes will be 64-bit. When run in 32-bit any created attributes will be 32-bit. Use Attribute Cast to change the preferred precision.
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
Referring to the geometry currently being processed is special as you have to ensure a copy is made so the VEX functions can refer to its original form. This handles that for you.
Nth Context Geometry
These refer to the SOPs wired into the parent DOP Network itself.
Myself (No Reads from Outputs)
Refers the currently processed geometry. Does not make a copy so it is up to the user to ensure no reads are made from any attributes that are bound.
Path to a SOP to wire in.
Name of a piece of DOP data on THIS object to wire in.