Cache_Disk : Helper

 
 
 
Cache_Disk - superclass: helper; super-superclass:node - 21:0 - classID: #(1935830029, 515064320) 

Value > MAXWrapper > Node > Helper > Cache_Disk

 

   

Particle Flow - Quick Navigation

Description:

NEW in 3ds Max 2014: The Cache_Disk operator records particle states to disk for faster feedback. Some particle properties can be excluded from caching, and extra operators can be called to restore the data.

   

Constructors:

Cache_Disk...
CacheDisk...

   

Properties:

<Cache_Disk>.Use_At     Integer    default: 0   --  integer

Get/set the selection of the "Use At" drop-down list.

Possible values are:

0 - Viewport

1 - Render

2 - Viewport/Render

   

<Cache_Disk>.Range_Type     Integer    default: 0   --  integer

Get/set the selection of the "Range" drop-down list.

Possible values are:

0 - Active Segment (default)

1 - Custom

   

<Cache_Disk>.Start_Time     Time    default: 0f   --  time

Get/set the value of the "Start Time" spinner.

It is only used when the .Range_Type property is set to 1 - Custom.

<Cache_Disk>.End_Time     Time    default: 30f   --  time

Get/set the value of the "End Time" spinner.

It is only used when the .Range_Type property is set to 1 - Custom.

   

<Cache_Disk>.Sampling_Type     Integer    default: 0   --  integer

Get/set the selection of the "Sampling" drop-down list.

Possible values are:

0 - Every Frame (default)

1 - Integration Step

2 - Nth Frame

   

<Cache_Disk>.Every_Nth_Frame     Integer    default: 5   --  integer

Get/set the value of the "N" spinner.

   

<Cache_Disk>.Cache_Test_Results     BooleanClass    default: true   --  boolean

Get/set the state of the "Cache Test Results" checkbox.

   

Cache Files group of controls

<Cache_Disk>.Write_To_File     UndefinedClass    default: undefined   --  filename

Get/set the cache file name.

   

Update And Reset group of controls

<Cache_Disk>.Update_Clear_Range_Type     Integer    default: 0   --  integer

Get/set the selection of the Update And Reset > "Range" drop-down list.

Possible values are:

0 - Active Segment (default)

1 - Custom

   

<Cache_Disk>.Update_Clear_Start_Time     Time    default: 0f   --  time

Get/set the value of the Update And Reset > "Start Time" spinner.

   

<Cache_Disk>.Update_Clear_End_Time     Time    default: 30f   --  time

Get/set the value of the Update And Reset > "End Time" spinner.

   

<Cache_Disk>.Update_Viewports     BooleanClass    default: true   --  boolean

Get/set the state of the "Update Viewports" checkbox.

   

Exclude Data From Cache group of controls

<Cache_Disk>.Exclude_Shape     BooleanClass    default: false   --  boolean

Get/set the state of the "Shape" checkbox.

   

<Cache_Disk>.Exclude_Scale     BooleanClass    default: false   --  boolean

Get/set the state of the "Scale" checkbox.

   

<Cache_Disk>.Exclude_Mapping     BooleanClass    default: false   --  boolean

Get/set the state of the "Mapping" checkbox.

   

<Cache_Disk>.Exclude_Script_Data     BooleanClass    default: false   --  boolean

Get/set the state of the "Script Data" checkbox.

   

<Cache_Disk>.Exclude_Material_ID     BooleanClass    default: false   --  boolean

Get/set the state of the "Material ID" checkbox.

   

<Cache_Disk>.Exclude_Rotation     BooleanClass    default: false   --  boolean

Get/set the state of the "Rotation" checkbox.

   

Post-Cache Operators group of controls

<Cache_Disk>.Use_Post_Cache_Operators     BooleanClass    default: false   --  boolean

Get/set the state of the "Use Post Cache Operators" checkbox.

   

<Cache_Disk>.Post_Cache_Operators     ArrayParameter    default: #()   --  node array; SubAnim

Get/set the array of post-cache operators.

   

<Cache_Disk>.Memory_Limit     Integer    default: 100   --  integer

Get/set the value of the "Memory Limit" spinner.

   

Cache_Disk interfaces:

Interface: cache

Methods:

<boolean><Cache_Disk>.update()

Presses the "Update" button in the "Update And Reset" group of controls.

Returns True on success, False on failure.

<boolean><Cache_Disk>.clear()

Presses the "Clear" button in the "Update And Reset" group of controls.

Returns True on success, False on failure.

   

<boolean><Cache_Disk>.updateAll()

Presses the "Update All" button in the "Update And Reset" group of controls.

Returns True on success, False on failure.

<boolean><Cache_Disk>.clearAll()

Presses the "Clear All" button in the "Update And Reset" group of controls.

Returns True on success, False on failure.

   

<boolean><Cache_Disk>.clearMemory()

Presses the "Clear Memory" button.

Returns True on success, False on failure.

<boolean><Cache_Disk>.clearMemoryAll()

Presses the "Clear All" button.

Returns True on success, False on failure.

   

Interface: cacheDisk

Methods:

<filename><Cache_Disk>.getDefaultCachePath()

Returns the default cache path.

<bool><Cache_Disk>.setDefaultCachePath <filename>fileName

Sets the default cache path to the specified file name.

Returns True on success, False on failure.

   

The following common Particle Flow Interfaces are exposed by the Cache_Disk Class:

Interface: action

Interface: operator

Interface: PViewItem