pymel.core.system.exportEdits

exportEdits(*args, **kwargs)

Use this command to export edits made in the scene to a separate file. The exported file can be subsequently imported to another scene. Edits may include: nodes, connections and reference edits such as value changes. The nodes that are included in the exported file will be based on the options used. At least one option flag which describes the set of target nodes to include in the exported file must be specified (e.g. ‘selected’, ‘onReferenceNode’). Use the inclusion flags (‘includeAnimation’, ‘includeShaders’, ‘includeNetwork’) to specify which additional related nodes will be added to the export list. In export mode, when the command completes successfully, the name of the exported file will be returned. In query mode, this command will return information about the contents of the export file. No file export is performed in query mode. Currently query mode will return the list of nodes that will be considered for inclusion in the exported file based on the combination of options specified

Flags:
Long name (short name) Argument Types Properties
editCommand (ec) unicode ../../../_images/create.gif ../../../_images/query.gif
 

This is a secondary flag used to indicate which type of reference edits should be considered by the command. If this flag is not specified all edit types will be included. This flag requires a string parameter. Valid values are: “addAttr”, “connectAttr”, “deleteAttr”, “disconnectAttr”, “parent”, and “setAttr”. In some contexts, this flag may be specified more than once to specify multiple edit types to consider.

excludeHierarchy (ehr) bool ../../../_images/create.gif ../../../_images/query.gif
 

By default exporting passes all DAG parents and DAG history to the export file. To prevent any DAG relations not otherwise connected to the target nodes to be output, specify the -excludeHierarchy flag.

excludeNode (en) unicode ../../../_images/create.gif ../../../_images/query.gif
 

Prevent the node from being included in the list of nodes being exported. This flag is useful to exclude specific scene nodes that might otherwise be exported. In the case where more than one Maya node has the same name, you can specify the DAG path to uniquely identify the node.

exportSelected (exs) bool ../../../_images/create.gif ../../../_images/query.gif
 

The selected nodes and their connections to each other will be exported. Additionally, any dangling connections to non-exported nodes will be exported. Any default nodes (the internal nodes that Maya creates on startup) that are selected are skipped.

force (f) bool ../../../_images/create.gif ../../../_images/query.gif
 
Force the export action to take place. This flag is required to overwrite an existing file.
includeAnimation (ian) bool ../../../_images/create.gif ../../../_images/query.gif
 
Additionally includes animation nodes and animation helper nodes associated with the target nodes being exported.
includeConstraints (ic) bool ../../../_images/create.gif ../../../_images/query.gif
 
Additionally include constraint-related nodes associated with the target nodes being exported.
includeDeformers (idf) bool ../../../_images/create.gif ../../../_images/query.gif
 
Additionally include deformer networks associated with the target nodes being exported.
includeNetwork (inw) bool ../../../_images/create.gif ../../../_images/query.gif
 
Additionally includes the network of nodes connected to the target nodes being exported.
includeNode (includeNode) unicode ../../../_images/create.gif ../../../_images/query.gif
 

Additionally include the named node in the list of nodes being exported. In the case where more than one Maya node has the same name, you can specify the DAG path to uniquely identify the node.

includeSetAttrs (isa) bool ../../../_images/create.gif ../../../_images/query.gif
 

When using the -selected/-sel flag, if any of the selected nodes are referenced, also include/exclude any setAttr edits on those nodes. If used with the -onReferenceNode/-orn flag, include/exclude any setAttr edits on the reference.

includeSetDrivenKeys (sdk) bool ../../../_images/create.gif ../../../_images/query.gif
 
Additionally include setDrivenKey-related nodes associated with the target nodes being exported.
includeShaders (ish) bool ../../../_images/create.gif ../../../_images/query.gif
 
Additionally include shaders associated with the target nodes being exported.
onReferenceNode (orn) unicode ../../../_images/create.gif ../../../_images/query.gif
 

This is a secondary flag used to indicate that only those edits which are stored on the indicated reference node should be considered. This flag only supports multiple uses when specified with the “exportEdits” command.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

selected (sel) bool ../../../_images/create.gif ../../../_images/query.gif
 

Export will operate on the list of nodes currently selected. This flag differs from the exportSelected flag in that the selected nodes are not exported, only the edits on them, and any nodes found via the include flags the are used (such as includeAnimation, includeNetwork and so on).

type (typ) unicode ../../../_images/create.gif ../../../_images/query.gif
 

Set the type of the exported file. Valid values are “editMA” or “editMB”. Note that this command respects the global “defaultExtensions” setting for file naming that is controlled with the file command defaultExtensions option. See the file command for more information.

Derived from mel command maya.cmds.exportEdits

Example:

import pymel.core as pm

import maya.cmds as cmds

# query nodes to be exported, target is selected nodes, include related shaders
nodeList = pm.exportEdits(query=1,selected=1,includeShaders=1)
# exported selected nodes and related animation nodes to file
pm.exportEdits("myExportFile.ma",type='editMA',selected=1,includeShaders=1)
# Result: C:/Documents and Settings/user/My Documents/maya/projects/default/scenes/myExportFile.editMA

Previous topic

pymel.core.system.exportAsReference

Next topic

pymel.core.system.exportSelected

Core

Core Modules

Other Modules

This Page