Adding behaviours

Clip reader behaviour module

This module attaches a clip reader node to each agent, so every agent will play a specific clip

• Create an agent group.
• Add a grid layout module and set the size attribute to (3,1,3).
• Add a clip reader module.
• Set a compatible clip in the clipName attribute of the clip reader module.
• If you want set a different clip for some agents press the icon next to the clipName field. Select the agent you want from the list inside the agents override dialog and set a clip name. You might also select the agents with the agent layout tool.
• Rewind your scene and the press play.

State machine behaviour module

This module creates all the nodes needed by the state machine (clip reader, merge, state machine) inside the DG network of each agent, then the "state" metadata is used to play the right animation clip based on the data from the state machine.

• Create an agent group.
• Add a grid layout module and set the size attribute to (3,1,3).
• Add a state machine module.
• Set a valid id number in the state attribute of the state machine module (if you are using the man agent type, use 1 for the walk state).
• Rewind your scene and the press play.
• The state attribute can be animated, so put a key frame at frame 20 with value 1 and one at frame 21 with value 2. In Maya, you can do this both by right clicking on the field and selecting "Set key".
• Rewind your scene and the press play.
• You can override the state of some agent using agents override dialog.

Follow curve behaviour module

Let's start with the follow curve module.

• Create an agent group.
•  Add a grid layout module.
•  Add state machine module. Set the "state" attribute of the stateMachine module to 1.
• Create a curve in your scene.
• Add a follow curve module.
• In the curve attribute of the follow curve module drag and drop form the Outliner (middle mouse button) the curve or type the curve name inside the attribute field.
• Rewind your scene and the press play. The agent will follow your curve.

Curve field behaviour module

The curve field generates a vector field using multiple curves so the agents are affected by the direction of multiple curves

• Create an agent group.
•  Add a grid layout module, Set the size to (3,1,3).
•  Add state machine module. Set the "state" attribute of the stateMachine module to 1.
• Create some curves in your scene.
• Add a curve field module.
• In the curves attribute of the curve field module, expand the panel and press the add button to add input curves and then drag and drop from the Outliner the curves (middle mouse button) or type the names inside each field.
• Set max distance attribute to 500.
• Rewind your scene and the press play. The agents will follow the curves you created.

Mesh avoidance behaviour module

With this module you can avoid the intersection between agents and geometries in your scene

• Create an agent group
• Add a grid layout module
• Add state machine module. Set the "state" attribute of the stateMachine module to 1
• Create a curve in your scene
• Add a follow curve module
• Maya: In the curve attribute of the follow curve module drag and drop form the Outliner (middle mouse button) the curve or type the curve name inside the attribute field. Houdini: Assign the curve to the curve parameter.
• Create a cube or some geo in your scene. If you are going to create multiple geos, please remember to combine all together.
• Add a mesh avoidance module.
• In the mesh attribute of the mesh avoidance module drag and drop form the Outliner the geo (middle mouse button) or type its name inside the attribute field.
• Rewind your scene and the press play. The agent will follow the curve you created avoiding the geos

Please remember that the module are evaluated from top to down. In this case the mesh avoidance should be at the bottom because it should override the direction that comes from the follow curve module. If you put the mesh avoidance module before the follow curve you will have a wrong behaviour because the follow curve will override the directions from the mesh avoidance module

Area trigger behaviour module

With this module you can change a metadata value when the agents enter inside a mesh area

• Create an agent group
• Add a grid layout module and set the size to (5,1,5)
• Add state machine module. Set the "state" attribute of the stateMachine module to 1
• Create a curve in your scene
• Add a follow curve module
• In the curve attribute of the follow curve module drag and drop form the Outliner (middle mouse button) the curve or type the curve name inside the attribute field.
• Create a plane, scale it and put it in front of the agents
• Add a area trigger module
• Connect the plane to the mesh attribute of the area trigger, you can drag and drop from the Outliner (middle mouse button)  or write the plane name in the mesh field.
• Set the metadata attribute in the area trigger module to state
• Set the intValue attribute in the area trigger module to 2 in this way the agents will change the state to 2
• Set the keepValue on so the agents will keep the new state value
• Add another area trigger module and create and attach a new plane
• Inside the new area trigger module, set the metadata to frameRate and the doubleValue to 0.5, the keepValue to off.
• Set the Blend In Frame and Blend Out Frame attribute of the new trigger module to 10
• To add more variation to your simulation set the Random In and Random Out Delay to 5
• Rewind your scene and the press play. Now when the agents enter inside the first plane they'll start to run because the state metadata is changed to 2, then when they enters in the second plane they slow down but only inside the plane.

Agent scale behaviour module

This module can change the scale of each agent

• Create an agent group.
• Add a grid layout module and set the size attribute to (5,1,5).
• Add state machine module.
• Add an agent scale module and set the scale attribute of the module to 2.
• Rewind the scene.
• To add more variation open the override dialog of the scale attribute, select some agents form the list, then press the "Value:" button and enter a range of 0.5-2.5, then press randomize.
• Rewind the scene.

Joint transform behaviour module

This module override or add an offset transformation to a joint

• Create an agent group.
• Add a grid layout module.
• Add state machine module.
• Add a joint transform module.
• Set the jointName attribute to "Head".
• Set rotate to (90,0,0)
• Set offset to on.
• Rewind the scene.
• You can also change the weight or add some keyframe to it.

To edit the joints of an agent you can also use the joint transform tool.

Parent constraint behaviour module

This module create a constraint between the agents and an object in your scene

• Create an agent group.
• Add a grid layout module and set the size attribute to (5,1,5).
• Add state machine module.
• Add a parent constraint module.
• Create a locator add a keyframe at frame 0, then at frame 120 move to (500,0,500), rotate, scale it and add another keyframe.
• Connect locator1.worldMatrix to tcAgentGroupNodeShape1.atoms_parentConstraint_parentMatrix
• Rewind the scene and press play.

Joint aim behaviour module

This module change the orientation of one joint in order to aim a point. It can also propagate the transformation to hi parents

• Create an agent group.
• Add a grid layout module.
• Add state machine module.
• Create a locator and move to (400,0,400).
• Add a joint aim module.
• Connect locator1.translate to tcAgentGroupNodeShape1.atoms_jointAim_target.
• Set the joint to "Spine2".
• Set the aim axis to Z.
• Set hierarchy propagation to 5.
• Rewind the scene and press play.

Tilt behaviour module

This module add a tilt transformation to the agents based on the slope of the group

• Create an agent group
• Add a grid layout module
• Add a state machine module and set the "state" attribute to 1
• Create a ground mesh with some hills
• Open the height field manager from the Atoms menu Atoms→Height field manager
• Select the ground and in the Height field manager press the ad button
• Set the height field name to "hf" and press the select button to set the mesh and press ok
• On the state machine module set "hf" as height field and rewind the scene
• Add the tilt module
• Set the height field attribute of the tilt module to "hf"
• Set the agent up and down angle to 5 and the ground up and down angle to 10
• Set the maxTiltAngleRate to 0.5
• Rewind the scene and press play
• Try to disable the tilt module using the checkbox near the module name rewind and press play to see the difference.