pymel.core.general.instancer

instancer(*args, **kwargs)

This command is used to create a instancer node and set the proper attributes in the node.

Maya Bug Fix:

• name of newly created instancer was not returned

Flags:

• addObject : a (bool) [create,edit]

  This flag indicates that objects specified by the -object flag will be added to the instancer node as instanced objects.

• cycle : c (unicode) [create,query,edit]

  This flag sets or queries the cycle attribute for the instancer node. The options are noneor sequential. The default is none.

• cycleStep : cs (float) [create,query,edit]

  This flag sets or queries the cycle step attribute for the instancer node. This attribute indicates the size of the step in frames or seconds (see cycleStepUnit).

• cycleStepUnits : csu (unicode) [create,query,edit]

  This flag sets or queries the cycle step unit attribute for the instancer node. The options are framesor seconds. The default is frames.

• index : i (int) [query]

  This flag is used to query the name of the ith instanced object.

• levelOfDetail : lod (unicode) [create,query,edit]

  This flag sets or queries the level of detail of the instanced objects. The options are geometry, boundingBox, boundingBoxes. The default is geometry.

• name : n (unicode) [create,query]

  This flag sets or queries the name of the instancer node.

• object : obj (unicode) [create,query,edit]

  This flag indicates which objects will be add/removed from the list of instanced objects. The flag is used in conjuction with the -add and -remove flags. If neither of these flags is specified on the command line then -add is assumed.

• objectPosition : op (unicode) [query]

  This flag queries the given objects position. This object can be any instanced object or sub-object.

• objectRotation : objectRotation (unicode) [query]

  This flag queries the given objects rotation. This object can be any instanced object or sub-object.

• objectScale : os (unicode) [query]

  This flag queries the given objects scale. This object can be any instanced object or sub-object.

• pointDataSource : pds (bool) [query]

  This flag is used to query the source node supply the data for the input points. Flag can have multiple arguments, passed either as a tuple or a list.

• removeObject : rm (bool) [edit]

  This flag indicates that objects specified by the -object flag will be removed from the instancer node as instanced objects.

• rotationOrder : ro (unicode) [create,query,edit]

  This flag specifies the rotation order associated with the rotation flag. The options are XYZ, XZY, YXZ, YZX, ZXY, or ZYX. By default the attribute is XYZ.

• rotationUnits : ru (unicode) [create,query,edit]

  This flag specifies the rotation units associated with the rotation flag. The options are degrees or radians. By default the attribute is degrees.

• valueName : vn (unicode) [query]

  This flag is used to query the value(s) of the array associated with the given name. If the -index flag is used in conjuction with this flag then the ith value will be returned. Otherwise, the entire array will be returned.

Derived from mel command maya.cmds.instancer