Geometry cache XML description file

 
 
 

When you create a geometry cache, your cache is saved to disk as a .mc (Maya cache) file and an .xml description file is generated for your cache. The XML (eXtensible Markup Language) description file contains a list of important cache attributes that Maya uses to locate the data files for your geometry cached objects and other useful information like its cache’s time range. You can use the XML description file to keep track of your geometry cache files and their associated objects and scenes.

Note

The XML description file is read-only.

The geometry cache information contained in the XML description file is structured or organized by XML element and attribute. Each regular element (such as cacheType and Channel) or nested element (such as channel#) contains single or multiple attributes (such as Type, ChannelName, or SamplingRate) that list specific geometry cache properties.

Autodesk_Cache_File

cacheType

Specifies the format of the geometry cache on disk.

Type

Select from the following options:

OneFile

Specifies that the geometry cache is contained in a single Maya cache file.

OneFilePerFrame

Specifies that the geometry cache is divided into multiple Maya cache files, one file per cached frame.

time

Range

Specifies the frame or time range of the geometry cache. For example, if a geometry cache contains an object’s deformations from frames 1-25, then the Range attribute would be 250-6250.

The time range is measured in time steps. Time steps are sub-frame units. Each geometry cache frame contains multiple time steps. The number of time steps contained in a frame is determined by your current Working Units (Time) user preference setting.

Number of time steps per frame = 6000/frame rate. For example, if your Working Units (Time) preference is set to Film (24 fps), then each of your geometry cache’s frames contains 250 time steps.

cacheTimePerFrame

TimePerFrame

Specifies the number of time steps in each frame for the geometry cache.

cacheVersion

Version

Specifies the version number of the Maya geometry caching functionality that created the current XML description file and its geometry cache files.

extra

Specifies the following for the geometry cache:

  • The name of the geometry cache’s Maya scene file and its location on disk.
  • The version of Maya in which the geometry cache was created.
  • The name of the account that created the geometry cache.

Channels

Contains all object or channel-specific geometry cache information.

channel#

Each geometry cached object is assigned its own channel# nested element. For example, if you select 5 objects, set File Distribution to One File or One File Per Frame, and cache their deformations, then one XML description file would be generated and it would contain the following nested elements: channel0, channel1, channel2, channel3, and channel4. However, if you set File Distribution to One File Per Geometry, then one XML description file would be generated for each of the selected objects and only one channel# nested element would appear in each .xml file.

ChannelName

Specifies the name of the object to which the geometry cache belongs. This value is unique to each geometry cached object.

ChannelType

Specifies the data type of the array in which the channel’s geometry cache data is stored. Currently, only DoubleVectorArray is supported.

Channel Interpretation

Specifies which type of object data is driven by the channel’s geometry cache. Currently, only the Positions attribute value is supported.

SamplingType

Specifies whether or not the channel’s deformation samples are saved to disk at equally spaced intervals. Regular indicates that the samples were saved at equally spaced intervals and Irregular indicates that the samples were saved at unequally spaced intervals.

These values are used by Maya to help it search for the channel’s geometry cache files on disk more efficiently.

Typically, the sampling type for a geometry cache is always Regular after creation. However, if you edit your cache in a way that changes its sampling interval, its sampling type will change to Irregular. For example, if your geometry cache evaluates every frame, and you append a cache to it that evaluates every 2 frames, then your cache’s sampling type would change to Irregular.

SamplingRate

Specifies the spacing of the channel’s geometry cache files on disk when they were first created.

SamplingRate = Evaluate every frame(s) x Save every eval(s). For example, if you set Evaluate every frame(s) to 0.5 and Save every eval(s) to 1, and your user Working Units are set to 24 fps, then one sample would be taken and saved to your geometry cache every 125 time steps or half-frame.

StartTime

Specifies the time in time steps for the channel’s first cache file on disk.

EndTime

Specifies the time in time steps for the channel’s last cache file on disk.