Auxilliary File Enumeration Flags

Auxilliary File Enumeration Flags

Module description

Some scene entities depend on data files other then .max files.

These files are referred to as "auxiliary" files. The following are flags that used to customize the enumeration of these files. See Animatable::EnumAuxFiles(), ReferenceMaker::EnumAuxFiles() and Interface::EnumAuxFiles() for more details.

Macros

#define FILE_ENUM_INACTIVE   (1<<0)
 Enumerate inactive files. More...
 
#define FILE_ENUM_VP   (1<<1)
 Enumerate video post files. More...
 
#define FILE_ENUM_RENDER   (1<<2)
 Enumerate render files. More...
 
#define FILE_ENUM_ALL   (FILE_ENUM_INACTIVE|FILE_ENUM_VP|FILE_ENUM_RENDER)
 Enumerate ALL files. More...
 
#define FILE_ENUM_FILE_SAVE   (1<<3)
 Enumerate references to be saved to scene files. More...
 
#define FILE_ENUM_MISSING_ONLY   (1<<8)
 Enumerate missing files only. More...
 
#define FILE_ENUM_1STSUB_MISSING   (1<<9)
 Just numerate 1st file named by an IFL (Image File List) if missing. More...
 
#define FILE_ENUM_DONT_RECURSE   (1<<10)
 Do not enumerate references. More...
 
#define FILE_ENUM_CHECK_AWORK1   (1<<11)
 Do not enumerate things with flag A_WORK1 set. More...
 
#define FILE_ENUM_DONTCHECK_CUSTATTR   (1<<12)
 Do not enumerate custom attributes. More...
 
#define FILE_ENUM_SKIP_VPRENDER_ONLY   (1<<13)
 Skip files needed only for viewport rendering. More...
 
#define FILE_ENUM_ACCESSOR_INTERFACE   (1<<14)
 The callback object passed through is a IEnumAuxAssetsCallback derived object. More...
 
#define FILE_ENUM_RESERVED_1   (1<<15)
 Internal use only. More...
 
#define FILE_ENUM_MISSING_ACTIVE   (FILE_ENUM_VP|FILE_ENUM_RENDER|FILE_ENUM_MISSING_ONLY)
 To enumerate all active but missing files. More...
 
#define FILE_ENUM_MISSING_ACTIVE1   (FILE_ENUM_MISSING_ACTIVE|FILE_ENUM_1STSUB_MISSING )
 To enumerate all active but missing files. More...
 

Macro Definition Documentation

#define FILE_ENUM_INACTIVE   (1<<0)

Enumerate inactive files.

Inactive files are those that aren't being used currently. For instance, a texture map file that is present, but not activated in the materials editor user interface, is considered inactive.

#define FILE_ENUM_VP   (1<<1)

Enumerate video post files.

#define FILE_ENUM_RENDER   (1<<2)

Enumerate render files.

#define FILE_ENUM_ALL   (FILE_ENUM_INACTIVE|FILE_ENUM_VP|FILE_ENUM_RENDER)

Enumerate ALL files.

#define FILE_ENUM_FILE_SAVE   (1<<3)

Enumerate references to be saved to scene files.

#define FILE_ENUM_MISSING_ONLY   (1<<8)

Enumerate missing files only.

#define FILE_ENUM_1STSUB_MISSING   (1<<9)

Just numerate 1st file named by an IFL (Image File List) if missing.

If the flag is set, then any files that are needed only for viewport display (not for rendering) will be excluded from the enumeration. This is useful in render slave mode, when you do not want to consider a render a failure just because some viewport-only files are missing.

#define FILE_ENUM_DONT_RECURSE   (1<<10)

Do not enumerate references.

#define FILE_ENUM_CHECK_AWORK1   (1<<11)

Do not enumerate things with flag A_WORK1 set.

#define FILE_ENUM_DONTCHECK_CUSTATTR   (1<<12)

Do not enumerate custom attributes.

#define FILE_ENUM_SKIP_VPRENDER_ONLY   (1<<13)

Skip files needed only for viewport rendering.

#define FILE_ENUM_ACCESSOR_INTERFACE   (1<<14)

The callback object passed through is a IEnumAuxAssetsCallback derived object.

#define FILE_ENUM_RESERVED_1   (1<<15)

Internal use only.

#define FILE_ENUM_MISSING_ACTIVE   (FILE_ENUM_VP|FILE_ENUM_RENDER|FILE_ENUM_MISSING_ONLY)

To enumerate all active but missing files.

#define FILE_ENUM_MISSING_ACTIVE1   (FILE_ENUM_MISSING_ACTIVE|FILE_ENUM_1STSUB_MISSING )

To enumerate all active but missing files.

But only enumerate first subfile pointed to by an IFL (Image File List).

Note
Enumerating all of them can be very slow.