Go to: Synopsis. Return value. Related. Flags. Python examples.
translator(
[string]
, [defaultFileRule=boolean], [defaultOptions=string], [extension=boolean], [fileCompression=string], [filter=boolean], [findTranslator=[string, int]], [list=boolean], [loaded=boolean], [objectType=boolean], [optionsScript=boolean], [readSupport=boolean], [writeSupport=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
translator is undoable, queryable, and NOT editable.
Set or query parameters associated with the file translators specified
in as the argument.
| boolean | or string array depending upon which flags are specified. |
In query mode, return type is based on queried flag.
workspace
defaultFileRule, defaultOptions, extension, fileCompression, filter, findTranslator, list, loaded, objectType, optionsScript, readSupport, writeSupport
| Long name (short name) |
Argument types |
Properties |
|
defaultFileRule(dfr)
|
boolean
|
|
|
Returns the default file rule value, can return "" as well
|
|
defaultOptions(do)
|
string
|
|
|
Return/set a string of default options used by this translator.
|
|
extension(ext)
|
boolean
|
|
|
Returns the default file extension for this translator.
|
|
fileCompression(cmp)
|
string
|
|
|
Specifies the compression action to take when a file is saved.
Possible values are "compressed", "uncompressed" "asCompressed".
|
|
filter(f)
|
boolean
|
|
|
Returns the filter string used for this translator.
|
|
findTranslator(ft)
|
[string, int]
|
|
|
Returns the name of the translator that can handle the given file.
String argument is a file path.
Int argument is read and write attributes.
0: A translator that can read
1: A translator that can write
2: A translator that can read and write
|
|
list(l)
|
boolean
|
|
|
Return a string array of all the translators that are loaded.
|
|
loaded(ld)
|
boolean
|
|
|
Returns true if the given translator is currently loaded.
|
|
objectType(ot)
|
boolean
|
|
|
This flag is obsolete. This will now return the same results as
defaultFileRule going forward.
|
|
optionsScript(os)
|
boolean
|
|
|
Query the name of the options script to use to post the user
options UI. When this script is invoked it will expect the name of the
parent layout in which the options will be displayed as well as the name
of the callback to be invoked once the apply button has been depressed
in the options area.
|
|
readSupport(rs)
|
boolean
|
|
|
Returns true if this translator supports read operations.
|
|
writeSupport(ws)
|
boolean
|
|
|
Returns true if this translator supports write operations.
|
|
|
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
# Returns true if dxf files can be read.
cmds.translator( 'dxf', q=True, rs=True )