pymel.core.effects.emitter

emitter(*args, **kwargs)

Creates an emitter object. If object names are provided or if objects are selected, applies the emitter to the named/selected object(s)in the scene. Particles will then be emitted from each. If no objects are named or selected, or if the -pos option is specified, creates a positional emitter. If an emitter was created, the command returns the name of the object owning the emitter, and the name of emitter shape. If an emitter was queried, the command returns the results of the query. Keyframeable attributes of the emitter node: rate, directionX, directionY, directionZ, minDistance, maxDistance, spread.

Flags:

Long Name / Short Name Argument Types Properties
alongAxis / alx float ../../../_images/query.gif ../../../_images/edit.gif
  Initial velocity multiplier in the direction along the central axis of the volume. See the diagrams in the documentation. Applies only to volume emitters.
aroundAxis / arx float ../../../_images/query.gif ../../../_images/edit.gif
  Initial velocity multiplier in the direction around the central axis of the volume. See the diagrams in the documentation. Applies only to volume emitters.
awayFromAxis / afx float ../../../_images/query.gif ../../../_images/edit.gif
  Initial velocity multiplier in the direction away from the central axis of the volume. See the diagrams in the documentation. Used only with the cylinder, cone, and torus volume emitters.
awayFromCenter / afc float ../../../_images/query.gif ../../../_images/edit.gif
  Initial velocity multiplier in the direction away from the center point of a cube or sphere volume emitter. Used only with the cube and sphere volume emitters.
cycleEmission / cye unicode ../../../_images/query.gif ../../../_images/edit.gif
  Possible values are noneand frame.Cycling emission restarts the random number stream after a specified interval. This can either be a number of frames or a number of emitted particles. In each case the number is specified by the cycleInterval attribute. Setting cycleEmission to frameand cycleInterval to 1 will then re-start the random stream every frame. Setting cycleInterval to values greater than 1 can be used to generate cycles for games work.
cycleInterval / cyi int ../../../_images/query.gif ../../../_images/edit.gif
  Specifies the number of frames or particles between restarts of the random number stream. See cycleEmission. Has no effect if cycleEmission is set to None.
directionX / dx float ../../../_images/query.gif ../../../_images/edit.gif
  x-component of emission direction. Used for directional emitters, and for volume emitters with directionalSpeed.
directionY / dy float ../../../_images/query.gif ../../../_images/edit.gif
  y-component of emission direction. Used for directional emitters, and for volume emitters with directionalSpeed.
directionZ / dz float ../../../_images/query.gif ../../../_images/edit.gif
  z-component of emission direction. Used for directional emitters, and for volume emitters with directionalSpeed.
directionalSpeed / drs float ../../../_images/query.gif ../../../_images/edit.gif
  For volume emitters only, adds a component of speed in the direction specified by the directionX, Y, and Z attributes. Applies only to volume emitters. Does not apply to other types of emitters.
maxDistance / mxd float ../../../_images/query.gif ../../../_images/edit.gif
  Maximum distance at which emission ends.
minDistance / mnd float ../../../_images/query.gif ../../../_images/edit.gif
  Minimum distance at which emission starts.
name / n unicode ../../../_images/query.gif ../../../_images/edit.gif
   
needParentUV / nuv bool ../../../_images/query.gif ../../../_images/edit.gif
  If aNeedParentUV is true, compute parentUV value from each triangle or each line segment, then send out to the target particle object. You also need to add parentU and parentV attributes to the particle object to store these values.
normalSpeed / nsp float ../../../_images/query.gif ../../../_images/edit.gif
  Normal speed multiple for point emission. For each emitted particle, multiplies the component of the velocity normal to the surface or curve by this amount. Surface and curve emitters only.
position / pos float, float, float ../../../_images/query.gif ../../../_images/edit.gif
  Positional emitter at world space location (x,y,z).
randomDirection / rnd float ../../../_images/query.gif ../../../_images/edit.gif
  Magnitude of a random component of the speed from volume emission.
rate / r float ../../../_images/query.gif ../../../_images/edit.gif
  Rate at which particles emitted (can be non-integer). For point emission this is rate per point per unit time. For surface emission it is rate per square unit of area per unit time.
scaleRateByObjectSize / sro bool ../../../_images/query.gif ../../../_images/edit.gif
  Applies to curve and surface emitters, only. If true, number of particles is determined by object size (area or length) times rate value. If false, object size is ignored and the rate value is used without modification. The former is the way Maya behaved prior to version 3.0.
scaleSpeedBySize / ssz bool ../../../_images/query.gif ../../../_images/edit.gif
  Indicates whether the scale of a volume emitter affects its velocity.
speed / spd float ../../../_images/query.gif ../../../_images/edit.gif
  Speed multiple. Multiplies the velocity of the emitted particles by this amount. Does not apply to volume emitters. For that emitter type, use directionalSpeed.
speedRandom / srn float ../../../_images/query.gif ../../../_images/edit.gif
  Identifies a range of random variation for the speed of each generated particle. If set to a non-zero value, speed becomes the mean value of the generated particles, whose speeds vary by a random amount up to plus or minus speedRandom/2. For example, speed 5 and speedRandom 2 will make the speeds vary between 4 and 6.
spread / sp float ../../../_images/query.gif ../../../_images/edit.gif
  Random spread (0-1), as a fraction of 90 degrees, along specified direction. Directional emitters only.
tangentSpeed / tsp float ../../../_images/query.gif ../../../_images/edit.gif
  Tangent speed multiple for point emission. For each emitted particle, multiplies the component of the velocity tangent to the surface or curve by this amount. Surface and curve emitters only.
torusSectionRadius / tsr float ../../../_images/query.gif ../../../_images/edit.gif
  Section radius for a torus volume. Applies only to torus. Similar to the section radius in the torus modelling primitive.
type / typ unicode ../../../_images/query.gif ../../../_images/edit.gif
  Type of emitter. The choices are omni | dir | direction | surf | surface | curve | curv. The default is omni. The full definition of these types are: omnidirectional point emitter, directional point emitter, surface emitter, or curve emitter.
volumeOffset / vof float, float, float ../../../_images/query.gif ../../../_images/edit.gif
  Volume offset of the emitter. Volume offset translates the emission volume by the specified amount from the actual emitter location. This is in the emitter’s local space.
volumeShape / vsh unicode ../../../_images/query.gif ../../../_images/edit.gif
  Volume shape of the emitter. Sets/edits/queries the field’s volume shape attribute. If set to any value other than none, determines a 3-D volume within which particles are generated. Values are: cube,sphere,cylinder,cone,torus.
volumeSweep / vsw float ../../../_images/query.gif ../../../_images/edit.gif
  Volume sweep of the emitter. Applies only to sphere, cone, cylinder, and torus. Similar effect to the sweep attribute in modelling. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.emitter

Example:

import pymel.core as pm

pm.particle( p=((-1, 5, 2), (2, 2, 2), (3, 3, 3)), n='particles' )
# Result: [nt.Transform(u'particles'), nt.Particle(u'particlesShape')] #
pm.emitter( 'particles', r=300, mnd=1.5, mxd=2.5, n='emitter' )
# Result: nt.Transform(u'particles') #
pm.particle( n='emitted' )
# Result: [nt.Transform(u'emitted'), nt.Particle(u'emittedShape')] #
pm.connectDynamic( 'emitted', em='emitter' )
# Result: [u'emittedShape'] #

# Creates a particle emitter.

pm.emitter( dx=1, dy=0, dz=0, sp=0.33, pos=(1, 1, 1), n='myEmitter' )
# Result: nt.PointEmitter(u'myEmitter') #
pm.particle( n='emittedParticles' )
# Result: [nt.Transform(u'emittedParticles'), nt.Particle(u'emittedParticlesShape')] #
pm.connectDynamic( 'emittedParticles', em='myEmitter' )
# Result: [u'emittedParticlesShape'] #

# Creates a point emitter.