Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In Atoms you can save your simulation on disk using Atoms caches

, then it

. It is possible to reuse these caches with the cacheReader behaviour module or with

a The Atoms Cache is lightweight and fast and it can increase the performance of your level.

 

You can also tweak your caches with the cache reader module in combination with the Layout Tool or

using

use other behaviour modules.

Widget Connector
overlayyoutube
_templatecom/atlassian/confluence/extra/widgetconnector/templates/youtube.vm
width720px
urlhttps://www.youtube.com/watch?v=OItd_5XOU0A
height540px

Exporting a cache

You can export a cache with the "Atoms Cache Exporter".  

Before you can export a cache you have to set up a level sequence. Create one from the viewport menu.

Image Modified

Then open the sequence into the sequencer and drag and drop the agent groups you want to export.

Finally for For each agent group, add a new track for the "Static Frame" property:Image Removed

Image Added

Finally set Set two or more key frames making sure their value actually match matche the frame number they are on. Set the interpolation of all key frames to linear or the exported simulation won't look right.

Now add a track for the “Use Static Frame“ property and set it to true. Otherwise, the agent group will not be driven by the sequence.


Image Added

Open the Atoms Cache Exporter via the Atoms Crowd MenuToolbar Button: Atoms Crowd Exporters > Cache Exporter 

There are a few options in the UI:

  • Level sequence

  • Export

    Output path

  • Cache

    Start Frame:

    The simulation will start exporting only from this frame in the sequencer. The "Set Start Cache Frame" button will take the start frame of the sequencer range and set on the "Cache Start Frame" field
  • Start Sim Frame: The simulation won't start until this frame in the sequencer. The "Set Start Sim Frame" button will take the start frame of the sequencer range and set on the "Start Sim Frame" field

Once all the fields are set you can click export.

Image Removed

Cache Exporter

The cache exporter will export four files per frame:

  • header: basic info such as number of agents at the current frame, number of created agents and number of deleted agents
  • frame: agent data such as agent type, position, velocity, bbox and variation
  • meta: agents metadata
  • pose: agent skeleton data
To make the caches more portable, all the agent type files are saved in a subfolder next to your cache files. The cache will also have a file with no padding containing global infos, such as start frame, end frame, agent ids, etc
  • cache start frame

  • End Frame: cache end frame

Image Added

Select the sequence you just created from the Level Sequence property widget.

This will fill the widget above with all the agent groups controlled by the level sequence.

Image Added

Now select the agent groups you want to export in a cache and press the right arrow icon.

This creates a tree, where the tom item is the name of the cache you are going to export. And the children are the agent groups this cache will contain.

Image Added

Right-click on the cache name to rename it or delete it. You can also use the small bin bottom to remove agent groups from a cache or the cache from the list.

If you want to add an agent group from an existing cache, select the cache from the right widget, the agent group format the left widget and pres the little right arrow button.

Image Added

You can export multiple caches at the same time. Just add them to the list.

Image Added

Set now a valid output path where the exporter is going to write caches. Se the start frame and end frame and press the export button.


Importing a cache

To import a cache from the disk, just drag and drop the file with no padding (i.e. mycache.atoms) inside the content browser.

You can then assign the new Atoms Cache Asset to Cache Reader module or to an Atoms Cache Actor. WarningPlease note, the atoms cache exporter for Atoms Realtime does not export the meshes like the cache exporter for Atoms Crowd does. If you are planning to use these caches in Atoms Crowd supported apps, please make sure to have a valid agent type configuration with skeleton and meshes.

Image Added

When importing a cache, Atoms will search for existing Agent Type assets. You can choose to use the existing agent types or import new ones using the agent type from the cache.

Image Added

It now generates an atoms cache asset. This asset doesn’t contain agent data but only a reference to the file on disk.

Image Added