pymel.core.effects.fluidEmitter

fluidEmitter(*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. Fluid 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.

Flags:

Long name (short name)		Argument Types	Properties
cycleEmission (cye)		unicode
	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
	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.
densityEmissionRate (der)		float
	Rate at which density is emitted.
fluidDropoff (fdr)		float
	Fluid Emission Dropoff in volume
fuelEmissionRate (fer)		float
	Rate at which is emitted. Flag can have multiple arguments, passed either as a tuple or a list.
heatEmissionRate (her)		float
	Rate at which density is emitted.
maxDistance (mxd)		float
	Maximum distance at which emission ends.
minDistance (mnd)		float
	Minimum distance at which emission starts.
name (n)		unicode
position (pos)		float, float, float
	Positional emitter at world space location (x,y,z).
rate (r)		float
	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.
torusSectionRadius (tsr)		float
	Section radius for a torus volume. Applies only to torus. Similar to the section radius in the torus modelling primitive.
type (typ)		unicode
	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
	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
	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
	Volume sweep of the emitter. Applies only to sphere, cone, cylinder, and torus. Similar effect to the sweep attribute in modelling.

Derived from mel command maya.cmds.fluidEmitter

Example:

import pymel.core as pm

pm.fluidEmitter( pos=(0, 0, 0), type='omni', der=1, her=2, fer=3, fdr=1.5, r=100.0, cye='none', cyi=1, mxd=0, mnd=0 )
# Result: nt.FluidEmitter(u'fluidEmitter1') #
pm.connectDynamic( 'fluidShape1', em='emitter1' )

# Creates an omni emitter that's emitting density, heat and fuel
# into fluidShape1