instancer

Go to: Synopsis. Return value. Keywords. Flags. MEL examples.

Synopsis

instancer [-addObject] [-cycle string] [-cycleStep float] [-cycleStepUnits string] [-index int] [-levelOfDetail string] [-name string] [-object string] [-objectPosition string] [-objectRotation string] [-objectScale string] [-pointDataSource] [-removeObject] [-rotationOrder string] [-rotationUnits string] [-valueName string]

instancer is undoable, queryable, and editable.

Return value

In query mode, return type is based on queried flag.

Keywords

Flags

Long name (short name)	Argument types	Properties
-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(-or)	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.
-addObject(-a)
This flag indicates that objects specified by the -object flag will be added to the instancer node as instanced objects.
-removeObject(-rm)
This flag indicates that objects specified by the -object flag will be removed from 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".
-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.
-pointDataSource(-pds)
This flag is used to query the source node supply the data for the input points.

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 be used more than once in a command.

MEL examples

polySphere -n myShape;
instancer -name myInstancerNode -a -object myShape;