Go to: Return value. Related commands. Flags. Examples.

Synopsis

particle [flags] [objectName]

The particle command creates a new particle object from a list of world space points. If a particle 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.

Return value

string : if the particle object is created float : if a float per particle attribute is being queried [float float float] : if a vector per particle attribute is being queried

Related commands

getParticleAttr, setParticleAttr, addPP, dynExport, emitter, connectDynamic, air, radial, gravity, newton, drag, goal, dynExpression, emit, event, collision

Flags

attribute, cache, conserve, count, deleteCache, dynamicAttrList, floatValue, gridSpacing, inherit, jitterBasePoint, jitterRadius, lowerLeft, name, numJitters, order, particleId, perParticleDouble, perParticleVector, position, shapeName, upperRight, vectorValue

Long name (short name)[argument types]Properties
-position (-p) float float floatmultiuse
World-space position of each particle.
-inherit (-i) floatqueryedit
Inherit this fraction (0-1) of emitting object's velocity.
-name (-n) stringqueryedit
name of particle object
-shapeName (-sn) stringqueryedit
Specify the shape name used for geometry instancing. DO not confuse this with the -n flag which names the particle object.
-count (-ct) query
Returns the number of particles in the object.
-dynamicAttrList (-dal) query
Returns a list of the dynamic attributes in the object.
-perParticleDouble (-ppd) query
Returns a list of the per-particle double attributes, excluding initial-state, cache, and information-only attributes.
-perParticleVector (-ppv) query
Returns a list of the per-particle vector attributes, excluding initial-state, cache, and information-only attributes.
-conserve (-c) floatqueryedit
Conservation of momentum control (between 0 and 1). Specifies the fraction of the particle shape's existing momentum which is conserved from frame to frame. A value of 1 (the default) corresponds to true Newtonian physics, in which momentum is conserved.
-particleId (-id) intqueryedit
Used in per particle attribute query and edit. Specifies the id of the particle whose attribute is being queried or edited. Querying the value of a per particle attribute requires the -attribute and -id or -order flags and their arguments to precede the -q flag.
-order (-or) intqueryedit
Used in per particle attribute query and edit. Specifies the zero-based order (index) of the particle whose attribute is being queried or edited in the particle array. Querying the value of a per particle attribute requires the -attribute and -id or -order flags and their arguments to precede the -q flag.
-attribute (-at) stringqueryedit
Used in per particle attribute query and edit. Specifies the name of the attribute being queried or edited.
-vectorValue (-vv) float float floatedit
Used only in per particle attribute edit. Specifies that the edit is of a vector attribute and must be followed by all three float values for the vector.
-floatValue (-fv) floatedit
Used only in per particle attribute edit. Specifies that the edit is of a float attribute and must be followed by the new float value.
-numJitters (-nj) int
Number of jitters (instances) per particle. Multi-use.
-jitterRadius (-jr) float
Max radius from the center to place the particle instances. Multi-use.
-jitterBasePoint (-jbp) float float float
Base point (center point) for jitters. The command will create one swatch of jitters for each base point. It will pair up other flags with base points in the order they are given in the command line. If not enough instances of the other flags are availble, the last one on the line with be used for all other instances of -jpb.
-gridSpacing (-grs) float
Spacing between particles in the grid.
-lowerLeft (-ll) float float float
Lower left point of grid.
-upperRight (-ur) float float float
Upper right point of grid.
-cache (-ch) boolean
Truns caching on/off for the particle shape.
-deleteCache (-dc)
Deletes the particle shapes cache. This command is not undoable.
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

Examples


     particle -p 0 0 0 -p 3 5 6 -p 5 6 7 -p 9 9 9;
 // Creates a particle object with four particles 

     particle -attribute age -id 5 -q particle1;
 // Returns the age of the particle with id 5 in object particle1
   
     particle -attribute velocity -order 7 -q;
 // Returns the velocity of the 7th particle in the currently selected
 // particle object
     
 // IMPORTANT NOTE:  Querying the value of a per particle attribute 
 // requires the -attribute and -id or -order flags and their arguments
 // to preceed the -q flag 
     
     particle -e -attribute velocity -order 7 -vectorValue 0.0 1.0 0.0;
 // Edits the velocity of the 7th particle in the currently selected
 // particle object to be 0.0, 1.0, 0.0
     
     particle -e -attribute mass -id 3 -fv 0.7 particle1;
 // Edits the mass of the particle in "particle1" with id 3 to be 0.7