Eyeon:Script/Reference/Applications/Fusion/Classes/Fusion/GetRegList

From VFXPedia

Jump to: navigation, search

Contents

Fusion : GetRegList

Arguments

GetRegList( mask )

  • mask

(required, constant)


A predefined constant that determines the type of registry entry returned by the function.

See VALID MASK CONSTANTS below.

Returns

A table of registry IDs.

Remarks

The Fusion registry stores information about the configuration and capabilities of a particular installation of Fusion. Details like which file formats are supported, and which tools are installed are found in the registry. Note that this is NOT the same thing as the operating system registry, the registry accessed by this function is unique to Fusion.

The only argument accepted by GetRegAttrs is a mask constant, which is used to filter the registry for specific registry types. The constants represent a particular type of registry entry, for example CT_Any will return all entries in the registry, while CT_Source will only return entries describing tools from the source category of tools (Loader, Plasma, Text...). A complete list of valid constants can be found here.

The GetRegList function returns a table, which contains a list of the Numeric ID values for each registry entry. The numeric ID is constant from machine to machine, e.g. the numeric ID for the QuickTime format would be 1297371438, regardless of the installation or version of Fusion.

These ID's are used as arguments to the GetRegAttrs() function, which provides access to the actual values stored in the specific registry setting.


Requirements

  • eyeonScript 5.0
  • Fusion 5.0


Examples

Example 1

-- this example will print out a list of all registry entries
 
fusion = Fusion()
reg = fusion:GetRegList(CT_Any)
 
for i=1,#reg do
   regattrs = fusion:GetRegAttrs(reg[i].ID)
   foreach(regattrs, print)
end

Example 2

-- this example will print out all of the 
-- image formats supported by this copy
-- of Fusion
 
fusion = StartFusion()
reg = fusion:GetRegList(CT_ImageFormat)
reg.Attrs = {}
 
 
for i = 1, #reg do
        reg.Attrs[i] = fusion:GetRegAttrs(reg[i].ID)
        name = reg.Attrs[i].MFREGS_FormatName
 
        if name == nil then
            name = reg.Attrs[i].REGS_Name
        end
 
        if reg.Attrs[i].MFREG_CanSave == 1 then
            print(name)
        else
            print(name .. " (Cannot Save)")
        end
end


  • See Also

GetRegAttrs()


Tips for GetRegList (edit)

Valid Mask Constants

CT_Tool
all tools
CT_Mask
mask tools only
CT_SourceTool
creator tools (images/3D/particles) all of which don't require an input image
CT_ParticleTool
CT_Modifier
CT_ImageFormat
CT_View
different sections of the interface
CT_GLViewer
all kinds of viewers, Fusion 6.4 or later
CT_PreviewControl
CT_InputControl
CT_BinItem