assembly is undoable, queryable, and editable.
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.
Long name (short name) |
Argument types |
Properties |
-active(-a)
|
string
|
|
|
Set or query the active representation for a specific assembly.
|
|
-canCreate(-cc)
|
string
|
|
|
Query the representation types the specific assembly can create.
|
|
-createOptionBoxProc(-cob)
|
script
|
|
|
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.
|
|
-createRepresentation(-cr)
|
string
|
|
|
Create and add a specific type of representation for an assembly.
Notice that "input" flag must be used with this flag.
|
|
-defaultType(-dt)
|
string
|
|
|
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.
|
|
-deleteRepresentation(-dr)
|
string
|
|
|
Delete a specific representation from an assembly.
|
|
-deregister(-d)
|
string
|
|
|
Deregister a registered assembly type.
If the deregistered type is the default type,
the default type will be set to the empty string.
|
|
-input(-in)
|
string
|
|
|
Specify the additional parameters of representation creation procedure
when creating a representation.
This flag must be used with createRepresentation flag.
|
|
-isAType(-isa)
|
string
|
|
|
Query whether the given object is of an assembly type.
|
|
-isTrackingMemberEdits(-ite)
|
string
|
|
|
Query whether the given object is tracking member edits.
|
|
-label(-lbl)
|
string
|
|
|
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.
|
|
-listRepresentations(-lr)
|
|
|
|
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.
|
|
-listRepTypes(-lrt)
|
|
|
|
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.
|
|
-listRepTypesProc(-lrp)
|
script
|
|
|
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.
|
|
-listTypes(-lt)
|
|
|
|
Query the supported assembly types.
|
|
-name(-n)
|
string
|
|
|
Specify the name of the assembly when creating it.
|
|
-repNamespace(-rns)
|
string
|
|
|
Query the representation namespace of this assembly node.
The value returned is used by Maya for creating the namespace where nodes created
by the activation of a representation will be added. If a name clash occurs when the
namespace is added to its parent namespace, Maya will update repNamespace with the new
name.
Two namespaces are involved when dealing with an assembly node: the namespace of the
assembly node itself (which this flag does not affect or query), and the namespace
of its representations. The representation namespace is a child of its assembly node's
namespace. The assembly node's namespace is set by its containing assembly, if it
is nested, or by the top-level file. Either the assembly node's namespace, or the
representation namespace, or both, can be the empty string.
It should be noted that if the assembly node is nested, the assembly
node's namespace will be (by virtue of its nesting) the
representation namespace of its containing assembly.
|
|
-repPostCreateUIProc(-poc)
|
string
|
|
|
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.
In query mode, this flag needs a value.
|
|
-repPreCreateUIProc(-pec)
|
string
|
|
|
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.
In query mode, this flag needs a value.
|
|
-proc(-prc)
|
script
|
|
|
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.
|
|
-postCreateUIProc(-aoc)
|
script
|
|
|
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.
|
|
-repLabel(-rl)
|
string
|
|
|
Query the label of the representation that is the argument to this flag, for
a given assembly.
In query mode, this flag needs a value.
|
|
-repType(-rt)
|
string
|
|
|
Specify a representation type to use as a filter for the -listRepresentations
query. The representation type is the argument to this flag.
In query mode, this flag needs a value.
|
|
-repTypeLabel(-rtl)
|
string
|
|
|
Query the label of the specific representation type.
In query mode, this flag needs a value.
|
|
-repTypeLabelProc(-rtp)
|
script
|
|
|
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.
|
|
-type(-typ)
|
string
|
|
|
Set or query properties for the specified registered assembly type.
In query mode, this flag needs a value.
|
|