Show frames

Go to: Synopsis. Return value. Keywords. Flags. MEL examples.

Synopsis

fluidCacheInfo [-attribute string] [-cacheTime time] [-endFrame] [-hasCache] [-hasData] [-initialConditions] [-playback] [-resolution] [-startFrame]

fluidCacheInfo is undoable, queryable, and editable.

A command to get information about the fluids cache. Get the startFrame and resolution for InitialConditions. Get the endFrame as well for a playback cache. Note that for the playback cache, it will look at the current time (or last frame if the current time is past end of cache)

Return value

None

In query mode, return type is based on queried flag.

Keywords

fluid

Flags

attribute, cacheTime, endFrame, hasCache, hasData, initialConditions, playback, resolution, startFrame
Long name (short name) Argument types Properties
-attribute(-at) string createqueryedit
Modifier to the "hasData" flag, used to query whether a cache has data (at the current time) for a specific fluid attribute. Valid attribute values are "density", "velocity", "temperature", "fuel", "color", "coordinates" (for texture coordinates), "falloff".
-cacheTime(-t) time createqueryedit
Only valid with the -hasData flag. The time the -hasData flag uses when it queries the cache to see if there is data.
-endFrame(-ef) createqueryedit
Returns end time of cache as float.
-hasCache(-hc) createqueryedit
Returns true if fluid has specified cache, false if not.
-hasData(-hd) createqueryedit
Queries whether a given cache has data in it at the time specified by the -time flag. (If not -time flag is present, -hasData assumes the current time.) When used with the "attribute" flag, indicates if data for the specified attribute exists in the cache. When used without the "attribute" flag, "hasData" indicates whether there is data in the cache for any of the valid fluid attributes.
-initialConditions(-ic) createqueryedit
Specifies the cache to be queried is the "Initial Conditions" cache.
-playback(-pb) createqueryedit
Specifies the cache to be queried is the "Playback" cache.
-resolution(-re) createqueryedit
Returns cache resolution as float[].
-startFrame(-sf) createqueryedit
Returns start time for cache as float.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

// get start frame for Initial Conditions Cache
fluidCacheInfo -ic -sf;
// get resolution for Initial Conditions Cache
fluidCacheInfo -ic -re;
// get end frame for Playback Cache
fluidCacheInfo -pb -ef;
// get resolution for Playback Cache
fluidCacheInfo -pb -re;
// Is there data for any of the valid properties
// in the playback cache?
fluidCacheInfo -pb -hd;
// Is there density data in the playback cache?
fluidCacheInfo -at density -pb -hd;