pymel.core.nodetypes.Instancer

class Instancer(*args, **kwargs)

class counterpart of mel function instancer

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

addObject(val=True, **kwargs)

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

Derived from mel command maya.cmds.instancer

allInstances()

Returns information about all instances generated by a particular particle instancer node. Since many particles will typically instance similar sets of paths, the information is returned in a compact representation. An array of paths is returned, representing the unique set of paths that are instanced by any particle in the system. For each particle, the routine returns a set of indices into this path array to illustrate the paths instanced at that particle. The index arrays for all particles are concatenated together, so a “start index” array is used to indicate which is the first entry in the index array for each particle. For each particle, the routine also returns the transformation matrix applied to that particle’s instanced paths to generate the final particle instance transformations.

Return type:(PyNode list, Matrix list, int list, int list)

Derived from api method maya.OpenMayaFX.MFnInstancer.allInstances

getCycle(**kwargs)

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

Derived from mel command maya.cmds.instancer

getCycleStep(**kwargs)

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).

Derived from mel command maya.cmds.instancer

getCycleStepUnits(**kwargs)

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

Derived from mel command maya.cmds.instancer

getIndex(**kwargs)

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

Derived from mel command maya.cmds.instancer

getLevelOfDetail(**kwargs)

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

Derived from mel command maya.cmds.instancer

getObject(**kwargs)

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.

Derived from mel command maya.cmds.instancer

getObjectPosition(**kwargs)

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

Derived from mel command maya.cmds.instancer

getObjectRotation(**kwargs)

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

Derived from mel command maya.cmds.instancer

getObjectScale(**kwargs)

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

Derived from mel command maya.cmds.instancer

getPointDataSource(**kwargs)

This flag is used to query the source node supply the data for the input points.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.instancer

getRotationUnits(**kwargs)

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

Derived from mel command maya.cmds.instancer

getValueName(**kwargs)

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

instancesForParticle(p)

Returns the DAG paths and instancer matrix for all instances generated by a specified particle

Parameters :

p : int

The index of the particle being queried.

Return type:

(int, PyNode list, Matrix)

Derived from api method maya.OpenMayaFX.MFnInstancer.instancesForParticle

particleCount()

Returns the number of particles feeding the active instancer

Return type:int

Derived from api method maya.OpenMayaFX.MFnInstancer.particleCount

removeObject(val=True, **kwargs)

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

Derived from mel command maya.cmds.instancer

setCycle(val=True, **kwargs)

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

Derived from mel command maya.cmds.instancer

setCycleStep(val=True, **kwargs)

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).

Derived from mel command maya.cmds.instancer

setCycleStepUnits(val=True, **kwargs)

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

Derived from mel command maya.cmds.instancer

setLevelOfDetail(val=True, **kwargs)

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

Derived from mel command maya.cmds.instancer

setObject(val=True, **kwargs)

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.

Derived from mel command maya.cmds.instancer

setRotationUnits(val=True, **kwargs)

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

Derived from mel command maya.cmds.instancer