Go to: Synopsis. Return value. Keywords. Flags. Python examples.
instancer([addObject=boolean], [cycle=string], [cycleStep=float], [cycleStepUnits=string], [index=int], [levelOfDetail=string], [name=string], [object=string], [objectPosition=string], [objectRotation=string], [objectScale=string], [pointDataSource=boolean], [removeObject=boolean], [rotationOrder=string], [rotationUnits=string], [valueName=string])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
instancer is undoable, queryable, and editable.
This command is used to create a instancer node and set the proper
attributes in the node.
In query mode, return type is based on queried flag.
instancer
addObject, cycle, cycleStep, cycleStepUnits, index, levelOfDetail, name, object, objectPosition, objectRotation, objectScale, pointDataSource, removeObject, rotationOrder, rotationUnits, valueName
| Long name (short name) |
Argument types |
Properties |
addObject(a)
|
boolean
|
 
|
|
This flag indicates that objects specified by the -object flag will be added to
the instancer node as instanced objects.
|
|
cycle(c)
|
string
|
|
|
This flag sets or queries the cycle attribute for the instancer node.
The options are "none" or "sequential". The default is "none".
|
|
cycleStep(cs)
|
float
|
|
|
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)
|
string
|
|
|
This flag sets or queries the cycle step unit attribute for the instancer
node. The options are "frames" or "seconds". The default is "frames".
|
|
index(i)
|
int
|
|
|
This flag is used to query the name of the ith instanced object.
|
|
levelOfDetail(lod)
|
string
|
|
|
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)
|
string
|
|
|
This flag sets or queries the name of the instancer node.
|
|
object(obj)
|
string
|
|
|
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)
|
string
|
|
|
This flag queries the given objects position. This object can be any instanced object or
sub-object.
|
|
objectRotation(objectRotation)
|
string
|
|
|
This flag queries the given objects rotation. This object can be any instanced object or
sub-object.
|
|
objectScale(os)
|
string
|
|
|
This flag queries the given objects scale. This object can be any instanced object or
sub-object.
|
|
pointDataSource(pds)
|
boolean
|
|
|
This flag is used to query the source node supply the data for the input points.
|
|
removeObject(rm)
|
boolean
|
|
|
This flag indicates that objects specified by the -object flag will be
removed from the instancer node as instanced objects.
|
|
rotationOrder(ro)
|
string
|
|
|
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)
|
string
|
|
|
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)
|
string
|
|
|
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.
|
|
|
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
cmds.polySphere(n='myShape')
cmds.instancer( name='myInstancerNode', a=True, object='myShape' )