pymel.core.nodetypes.Assembly

class Assembly(*args, **kwargs)

class counterpart of mel function assembly

Command to register assemblies for the scene assembly framework, to create them, and to edit and query them. Assembly nodes are DAG nodes, and are therefore shown in the various DAG editors (Outliner, Hypergraph, Node Editor). At assembly creation time, the node name defaults to the node type name. The assembly command can create any node that is derived from the assembly node base class. It also acts as a registry of these types, so that various scripting callbacks can be defined and registered with the assembly command. These callbacks are invoked by Maya during operations on assembly nodes, and can be used to customize behavior. In query mode, return type is based on queried flag.

deregister(val=True, **kwargs)

Deregister a registered assembly type. If the deregistered type is the default type, the default type will be set to the empty string.

Derived from mel command maya.cmds.assembly

getActiveLabel(**kwargs)

Set the active representation by label, or query the label of the active representation. Edit mode can be applied to more than one assembly. Query mode will return a single string when only a single assembly is specified, and will return an array of strings when multiple assemblies are specified.

Derived from mel command maya.cmds.assembly

getCanCreate(**kwargs)

Query the representation types the specific assembly can create.

Derived from mel command maya.cmds.assembly

getCreateOptionBoxProc(**kwargs)

Set or query the option box menu procedure for a specific assembly type. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

getDefaultType(**kwargs)

Set or query the default type of assembly. When the assembly command is used to perform an operation on an assembly type rather than on an assembly object, it will be performed on the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

getIsAType(**kwargs)

Query whether the given object is of an assembly type.

Derived from mel command maya.cmds.assembly

getIsTrackingMemberEdits(**kwargs)

Query whether the given object is tracking member edits.

Derived from mel command maya.cmds.assembly

getLabel(**kwargs)

Set or query the label for an assembly type. Assembly type is specified with flag “type”. If no type specified, the default type is used.

Derived from mel command maya.cmds.assembly

getListRepTypes(**kwargs)

Query the supported representation types for a given assembly type. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

getListRepTypesProc(**kwargs)

Set or query the procedure that provides the representation type list which an assembly type supports. This procedure takes no argument, and returns a string array of representation types that represents the full set of representation types this assembly type can create. The assembly type for which this procedure applies will be the default type, unless the type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

getListRepresentations(**kwargs)

Query the created representations list for a specific assembly. The -repType flag can be used to filter the list and return representations for a single representation type. If the -repType flag is not used, all created representations will be returned.

Derived from mel command maya.cmds.assembly

getListTypes(**kwargs)

Query the supported assembly types.

Derived from mel command maya.cmds.assembly

getPostCreateUIProc(**kwargs)

Set or query the UI post-creation procedure for a given assembly type. This procedure will be invoked by Maya immediately after an assembly of the specified type is created from the UI, but not through scripting. It can be used to invoke a dialog, to obtain and set initial parameters on a newly-created assembly. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

getRepPostCreateUIProc(**kwargs)

Set or query the UI post-creation procedure for a specific representation type, and for a specific assembly type. This procedure takes two arguments, the first the DAG path to the assembly, and the second the name of the representation. It returns no value. It will be invoked by Maya immediately after a representation of the specified type is created from the UI, but not through scripting. It can be used to invoke a dialog, to obtain and set initial parameters on a newly-created representation. The representation type is the argument of this flag. The -proc flag must be used to specify the procedure name. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

getRepPreCreateUIProc(**kwargs)

Set or query the UI pre-creation procedure for a specific representation type, and for a specific assembly type. This procedure takes no argument, and returns a string that is passed as an argument to the -input flag when Maya invokes the assembly command with the -createRepresentation flag. The representation pre-creation procedure is invoked by Maya immediately before creating a representation of the specified type from the UI, but not through scripting. It can be used to invoke a dialog, to obtain the creation argument for a new representation. The representation type is the argument of this flag. The -proc flag must be used to specify the procedure name. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

getRepTypeLabel(**kwargs)

Query the label of the specific representation type.

Derived from mel command maya.cmds.assembly

getRepTypeLabelProc(**kwargs)

Set or query the procedure that provides the representation type label, for a given assembly type. The procedure takes the representation type as its sole argument, and returns a localized representation type label. The assembly type for which this procedure applies will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

getType(**kwargs)

Set or query properties for the specified registered assembly type. Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.assembly

input(val=True, **kwargs)

Specify the additional parameters of representation creation procedure when creating a representation. This flag must be used with createRepresentation flag.

Derived from mel command maya.cmds.assembly

newRepLabel(val=True, **kwargs)

Specify the representation label to set on representation label edit.

Derived from mel command maya.cmds.assembly

proc(val=True, **kwargs)

Specify the procedure when setting the representation UI post- or pre-creation procedure, for a given assembly type. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

renameRepresentation(val=True, **kwargs)

Renames the representation that is the argument to this flag. The repName flag must be used to provide the new name.

Derived from mel command maya.cmds.assembly

repName(val=True, **kwargs)

Specify the representation name to set on representation creation or rename. This flag is optional with the createRepresentation flag: if omitted, the assembly will name the representation. It is mandatory with the renameRepresentation flag.

Derived from mel command maya.cmds.assembly

setActive(val=True, **kwargs)

Set the active representation by name, or query the name of the active representation. Edit mode can be applied to more than one assembly. Query mode will return a single string when only a single assembly is specified, and will return an array of strings when multiple assemblies are specified. Using an empty string as name means to inactivate the currently active representation.

Derived from mel command maya.cmds.assembly

setActiveLabel(val=True, **kwargs)

Set the active representation by label, or query the label of the active representation. Edit mode can be applied to more than one assembly. Query mode will return a single string when only a single assembly is specified, and will return an array of strings when multiple assemblies are specified.

Derived from mel command maya.cmds.assembly

setCreateOptionBoxProc(val=True, **kwargs)

Set or query the option box menu procedure for a specific assembly type. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

setDefaultType(val=True, **kwargs)

Set or query the default type of assembly. When the assembly command is used to perform an operation on an assembly type rather than on an assembly object, it will be performed on the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

setLabel(val=True, **kwargs)

Set or query the label for an assembly type. Assembly type is specified with flag “type”. If no type specified, the default type is used.

Derived from mel command maya.cmds.assembly

setListRepTypesProc(val=True, **kwargs)

Set or query the procedure that provides the representation type list which an assembly type supports. This procedure takes no argument, and returns a string array of representation types that represents the full set of representation types this assembly type can create. The assembly type for which this procedure applies will be the default type, unless the type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

setPostCreateUIProc(val=True, **kwargs)

Set or query the UI post-creation procedure for a given assembly type. This procedure will be invoked by Maya immediately after an assembly of the specified type is created from the UI, but not through scripting. It can be used to invoke a dialog, to obtain and set initial parameters on a newly-created assembly. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

setRepPostCreateUIProc(val=True, **kwargs)

Set or query the UI post-creation procedure for a specific representation type, and for a specific assembly type. This procedure takes two arguments, the first the DAG path to the assembly, and the second the name of the representation. It returns no value. It will be invoked by Maya immediately after a representation of the specified type is created from the UI, but not through scripting. It can be used to invoke a dialog, to obtain and set initial parameters on a newly-created representation. The representation type is the argument of this flag. The -proc flag must be used to specify the procedure name. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

setRepPreCreateUIProc(val=True, **kwargs)

Set or query the UI pre-creation procedure for a specific representation type, and for a specific assembly type. This procedure takes no argument, and returns a string that is passed as an argument to the -input flag when Maya invokes the assembly command with the -createRepresentation flag. The representation pre-creation procedure is invoked by Maya immediately before creating a representation of the specified type from the UI, but not through scripting. It can be used to invoke a dialog, to obtain the creation argument for a new representation. The representation type is the argument of this flag. The -proc flag must be used to specify the procedure name. The assembly type will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

setRepTypeLabelProc(val=True, **kwargs)

Set or query the procedure that provides the representation type label, for a given assembly type. The procedure takes the representation type as its sole argument, and returns a localized representation type label. The assembly type for which this procedure applies will be the default type, unless the -type flag is used to specify an explicit assembly type.

Derived from mel command maya.cmds.assembly

setType(val=True, **kwargs)

Set or query properties for the specified registered assembly type. Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.assembly