Go to: Synopsis. Return value. Keywords. Flags. Python examples.
colorManagementFileRules([addRule=string], [colorSpace=string], [down=string], [evaluate=string], [extension=string], [listRules=boolean], [load=boolean], [moveUp=string], [pattern=string], [remove=string], [save=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
colorManagementFileRules is NOT undoable, queryable, and editable.
This non-undoable action manages the list of rules that Maya uses to assign
an initial input color space to dependency graph nodes that read in color
information from a file. Rules are structured in a chain of
responsibility, from highest priority rule to lowest priority rule, each
rule matching a file path pattern and extension. If a rule matches a given
file path, its color space is returned as the result of rules evaluation,
and no further rule is considered. The lowest priority rule will always
return a match.
Rules can be added, removed, and changed in priority in the list. Each
rule can have its file path pattern, extension, and color space changed.
The rule list can be saved to user preferences, and loaded from user
preferences.
None
In query mode, return type is based on queried flag.
color, management
addRule, colorSpace, down, evaluate, extension, listRules, load, moveUp, pattern, remove, save
| Long name (short name) |
Argument types |
Properties |
addRule(add)
|
string
|
 
|
|
Add a rule with the argument name to the list of rules, as the
highest-priority rule. If this flag is used, the pattern, extension, and
colorSpace flags must be used as well, to specify the file rule pattern,
extension, and color space, respectively.
|
|
colorSpace(cs)
|
string
|
|
|
The input color space for the rule. If the rule matches a file path, this
is the color space that is returned. This color space must match an existing
color space in the input color space list.
|
|
down(dwn)
|
string
|
|
|
Move the rule with the argument name down one position towards lower priority.
|
|
evaluate(ev)
|
string
|
|
|
Evaluates the list of rules and returns the input color space name that
corresponds to the argument file path.
|
|
extension(ext)
|
string
|
|
|
The file extension for the rule, expressed as a glob pattern: for example, '*'
matches all extensions. For more information about glob pattern syntax, see
http://en.wikipedia.org/wiki/Glob_%28programming%29.
|
|
listRules(lsr)
|
boolean
|
|
|
Returns an array of rule name strings, in order, from lowest-priority (rule 0)
to highest-priority (last rule in array).
|
|
load(ld)
|
boolean
|
|
|
Read the rules from Maya preferences. Any existing rules are cleared.
|
|
moveUp(up)
|
string
|
|
|
Move the rule with the argument name up one position towards higher priority.
|
|
pattern(pat)
|
string
|
|
|
The file path pattern for the rule. This is the substring to match in the
file path, expressed as a glob pattern: for example, '*' matches all files.
For more information about glob pattern syntax, see
http://en.wikipedia.org/wiki/Glob_%28programming%29.
|
|
remove(rm)
|
string
|
|
|
Remove the rule with the argument name from the list of rules.
|
|
save(sav)
|
boolean
|
|
|
Save the rules to Maya preferences.
|
|
|
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 have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
import maya.cmds as cmds
cmds.colorManagementFileRules(add='ruleName', pattern='filePattern', extension='extension', colorSpace='colorSpace')
cmds.colorManagementFileRules(remove='ruleName')
cmds.colorManagementFileRules(up='ruleName')
cmds.colorManagementFileRules(down='ruleName')
cmds.colorManagementFileRules('ruleName', edit=True, pattern='filePattern')
cmds.colorManagementFileRules('ruleName', edit=True, extension='extension')
cmds.colorManagementFileRules('ruleName', edit=True, colorSpace='colorSpace')
cmds.colorManagementFileRules('ruleName', query=True, pattern=True)
cmds.colorManagementFileRules('ruleName', query=True, extension=True)
cmds.colorManagementFileRules('ruleName', query=True, colorSpace=True)
cmds.colorManagementFileRules(save=True)
cmds.colorManagementFileRules(load=True)
# Return array of rule name strings.
cmds.colorManagementFileRules(listRules=True)
# Return input space corresponding to file path.
cmds.colorManagementFileRules(evaluate=filePath)