Agent Vellum Unpack geometry node

Extracts geometry from agent primitives for a Vellum simulation.

On this page	Parameters Agents Geometry Pre-Roll Outputs Examples
Since	17.0

This SOP unpacks agent primitives for Vellum simulations and provides several higher-level features on top of the Agent Unpack SOP, such as separating the simulation geometry from collision geometry and performing a pre-roll.

If the agent shape to be simulated contains a Vellum setup from the Vellum Pack SOP, attributes on the simulation and constraint geometry will be updated to ensure correct behavior for agents that have been copied or transformed. This includes scaling the constraints' rest lengths for agents that have been scaled, and adjusting the point numbers for welds and attachment constraints when multiple agents are being unpacked.

Parameters ¶

Agents ¶

Select By

Specifies how to select the agents that will be unpacked and simulated.

Group

Point or primitive group specifying the subset of agents to unpack.

Layer Names

Agents will be unpacked if at least one of their current layers matches this pattern.

Geometry ¶

Select By

Specifies how to select the agent shapes that will be simulated. If the simulated shapes contain packed primitives with the vellum_type primitive attribute (i.e. from the Vellum Pack SOP), the simulation geometry and constraint geometry will be split into the first and second geometry outputs.

Layers to Simulate

The shapes in any agent layers matching this pattern will be unpacked as simulation and constraint geometry for the first and second outputs. Otherwise, layers will be unpacked as collision geometry for the third output.

The simulation layers will also be removed from the current layers of the agents in the fourth output. This leaves the agents with only their non-simulation layers, so they can be merged with the final simulated geometry from the Vellum Solver.

Shapes to Simulate

Any agent shapes matching this pattern will be unpacked as simulation and constraint geometry for the first and second outputs. Otherwise, the shape will be unpacked as collision geometry for the third output.

Delete Attributes

Specifies a list of attributes to delete from the unpacked geometry. This can be useful for removing attributes that are not needed for downstream operations, such as capture attributes.

Transfer Attributes

A list of attributes to transfer to the unpacked geometry. Computed point velocities are transferred if both v and w point attributes exist and are specified.

Transfer Groups

A list of groups to transfer to the unpacked geometry.

Pre-Roll ¶

Vellum Start Frame

Specifies the start frame that will be used for the Vellum simulation. If this is earlier than the Crowd Start Frame, a pre-roll will occur.

Crowd Start Frame

Specifies the initial frame of the input agents.

Use Rest Clip

If enabled, the pre-roll will blend each agent from the pose specified by the Rest Clip and Clip Time to the agent’s pose at the Crowd Start Frame. Otherwise, the pre-roll will blend from the agent’s undeformed (rest) geometry to the deformed geometry at the Crowd Start Frame.

Rest Clip

Specifies the clip to use when Use Rest Clip is enabled.

Clip Time

Specifies the clip time to use when Use Rest Clip is enabled.

Outputs ¶

Vellum Geometry

Geometry to be solved by the Vellum Solver.

Constraint Geometry

Constraints to be used with the Vellum Solver.

Collision Geometry

Collision geometry to be used with the Vellum Solver.

Agents

The input agents, with the Layers to Simulate removed from their current layers.

Examples ¶

SimpleCrowdCloth Example for Agent Vellum Unpack geometry node

This example demonstrates a simple workflow for simulating cloth on a crowd of characters using the Vellum solver.