Home PolylineEmitter
X_ite
Cancel

PolylineEmitter

Overview

PolylineEmitter emits particles along a single polyline. The coordinates for the line along which particles should be randomly generated are taken from a combination of the coord and coordIndex fields. The starting point for generating particles is randomly distributed along this line and given the initial speed and direction.

The PolylineEmitter node belongs to the ParticleSystems component and requires at least level 1, its default container field is emitter. It is available from X3D version 3.2 or higher.

Hierarchy

1
2
3
+ X3DNode
  + X3DParticleEmitterNode
    + PolylineEmitter

Fields

SFNode [in, out] metadata NULL [X3DMetadataObject]

Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.

Hint

MFInt32 [in] set_coordIndex [0,∞) or -1

Input field set_coordIndex.

SFBool [in, out] on TRUE

Enables/disables production of particles from this emitter node. If operating when turned off, existing particles complete their rendering process.

SFVec3f [in, out] direction 0 1 0 (-∞,∞)

Initial direction from which particles emanate.

SFFloat [in, out] speed 0 [0,∞)

Initial linear speed (default is m/s) imparted to all particles along their direction of movement.

SFFloat [in, out] variation 0.25 [0,∞)

Multiplier for the randomness used to control the range of possible output values. The bigger the value, the more random the output and the bigger the range of possible initial values possible.

Hint

  • variation of zero does not allow any randomness.

SFFloat [in, out] mass 0 [0,∞)

Basic mass of each particle, defined in mass base units (default is kilograms).

Hints

SFFloat [in, out] surfaceArea 0 [0,∞)

Particle surface area in area base units (default is meters squared). Surface area is used for calculations such as wind effects per particle.

Hints

  • surfaceArea value represents average frontal area presented to the wind.
  • Assumes spherical model for each particle (i.e., surface area is the same regardless of direction).

MFInt32 [ ] coordIndex -1 [0,∞) or -1

coordIndex indices are applied to contained Coordinate values in order to define randomly generated initial geometry of the particles.

Warnings

  • If no coordinates are available, PolylineEmitter acts like a point source located at local origin.
  • coordIndex is required in order to connect contained coordinate point values.

SFNode [in, out] coord NULL [X3DCoordinateNode]

Coordinates for the line along which particles are randomly generated.

Warning

  • If no coordinates are available, PolylineEmitter acts like a point source located at local origin.

Advice

Hint

  • If no coordinates are available, PolylineEmitter acts like a point source located at local origin.

Example

View Source in Playground

See Also

This post is licensed under CC BY 4.0 by the author.