pymel.core.effects.nParticle

nParticle(*args, **kwargs)

The nParticle command creates a new nParticle object from a list of world space points. If an nParticle object is created, the command returns the names of the new particle shape and its associated particle object dependency node. If an object was queried, the results of the query are returned. Per particle attributes can be queried using the particleId or the order of the particle in the particle array. If an object was edited, nothing is returned.

Flags:

Long name (short name)		Argument Types	Properties
attribute (at)		unicode
cache (ch)		bool
conserve (c)		float
count (ct)		bool
deleteCache (dc)		bool
dynamicAttrList (dal)		bool
floatValue (fv)		float
gridSpacing (grs)		float
inherit (i)		float
jitterBasePoint (jbp)		float, float, float
jitterRadius (jr)		float
lowerLeft (ll)		float, float, float
name (n)		unicode
numJitters (nj)		int
order (order)		int
particleId (id)		int
perParticleDouble (ppd)		bool
perParticleVector (ppv)		bool
position (p)		float, float, float
shapeName (sn)		unicode
upperRight (ur)		float, float, float
vectorValue (vv)		float, float, float

Derived from mel command maya.cmds.nParticle

Example:

import pymel.core as pm

# Creates a particle object with four particles
pm.nParticle( p=[(0, 0, 0), (3, 5, 6), (5, 6, 7), (9, 9, 9)] )
# Result: [nt.Transform(u'nParticle1'), nt.NParticle(u'nParticleShape1')] #

# Returns the age of the particle with id 2 in object particle1
pm.nParticle( 'particle1', q=True, attribute='age', id=2 )

# Returns the velocity of the 3rd particle in the currently selected
# particle object
pm.nParticle( attribute='velocity', q=True, order=3  )

# Edits the velocity of the 7th particle in the currently selected
# particle object to be 0.0, 1.0, 0.0
pm.nParticle( e=True, attribute='velocity', order=3, vectorValue=(0.0, 1.0, 0.0) )

# Edits the mass of the particle in "particle1" with id 3 to be 0.7
pm.nParticle( 'nParticle1', e=True, attribute='mass', id=3, fv=0.7 )