BaseParticleEmitter.hh
Go to the documentation of this file.
virtual double Rate() const override
Get how many particles per second should be emitted.
Definition: BaseParticleEmitter.hh:251
virtual ignition::math::Vector3d ParticleSize() const override
Get the particle dimensions (width, height, depth).
Definition: BaseParticleEmitter.hh:293
virtual void Reset()
Reset the particle emitter visual state.
Definition: BaseParticleEmitter.hh:210
EmitterType
Enum for emitter types.
Definition: ParticleEmitter.hh:36
virtual MaterialPtr Material() const override
Get the material which all particles in the emitter will use.
Definition: BaseParticleEmitter.hh:322
virtual double MaxVelocity() const override
Get the maximum velocity each particle is emitted (m/s).
Definition: BaseParticleEmitter.hh:343
virtual void SetEmitting(bool _enable) override
This is used to turn on or off particle emission. Default value is false.
Definition: BaseParticleEmitter.hh:286
virtual void SetDuration(double _duration) override
Set the number of seconds the emitter is active. A value of 0 means infinite duration. Default value is 0.
Definition: BaseParticleEmitter.hh:272
virtual void SetType(const EmitterType _type) override
Set the emitter type. Default value is EM_POINT.
Definition: BaseParticleEmitter.hh:229
virtual void SetEmitterSize(const ignition::math::Vector3d &_size) override
Set the size of the emitter where the particles are sampled. Default value is (1, 1...
Definition: BaseParticleEmitter.hh:243
virtual void SetColorRange(const ignition::math::Color &_colorStart, const ignition::math::Color &_colorEnd) override
Sets a color for all particle emitted. The actual color will be interpolated between these two colors...
Definition: BaseParticleEmitter.hh:373
STL class.
virtual double MinVelocity() const override
Get the minimum velocity each particle is emitted (m/s).
Definition: BaseParticleEmitter.hh:336
virtual ignition::math::Color ColorEnd() const override
Get the end color of the particles.
Definition: BaseParticleEmitter.hh:366
virtual void SetScaleRate(double _scaleRate) override
Set the amount by which to scale the particles in both x and y direction per second.
Definition: BaseParticleEmitter.hh:390
virtual std::string ColorRangeImage() const override
Get the path to the color image used as an affector.
Definition: BaseParticleEmitter.hh:397
virtual void SetRate(double _rate) override
Set how many particles per second should be emitted. Default value is 10.
Definition: BaseParticleEmitter.hh:258
virtual bool Emitting() const override
Is the particle emitter enabled?
Definition: BaseParticleEmitter.hh:279
virtual ignition::math::Vector3d EmitterSize() const override
Get the size of the emitter where the particles are sampled.
Definition: BaseParticleEmitter.hh:236
virtual void SetMaterial(const MaterialPtr &_material) override
Sets the material which all particles in the emitter will use.
Definition: BaseParticleEmitter.hh:329
virtual ~BaseParticleEmitter()
Destructor.
Definition: BaseParticleEmitter.hh:197
virtual ignition::math::Color ColorStart() const override
Get the starting color of the particles.
Definition: BaseParticleEmitter.hh:359
virtual void Init() override
Definition: BaseParticleEmitter.hh:203
BaseParticleEmitter()
Constructor.
Definition: BaseParticleEmitter.hh:191
Class to manage a particle emitter.
Definition: ParticleEmitter.hh:58
virtual void SetParticleSize(const ignition::math::Vector3d &_size) override
Set the particle dimensions (width, height, depth). Default value is {1, 1, 1}.
Definition: BaseParticleEmitter.hh:300
Definition: BaseScene.hh:36
static const Color White
virtual void SetLifetime(double _lifetime) override
Set the number of seconds each particle will ’live’ for before being destroyed. Default value is 5...
Definition: BaseParticleEmitter.hh:315
static const Vector3 One
virtual void SetColorRangeImage(const std::string &_image) override
Set the path to the color image used as an affector. This affector modifies the color of particles in...
Definition: BaseParticleEmitter.hh:404
virtual void SetVelocityRange(double _minVel, double _maxVel) override
Set a velocity range and each particle is emitted with a random velocity within this range (m/s)...
Definition: BaseParticleEmitter.hh:350
virtual double Duration() const override
Get the number of seconds the emitter is active. A value of 0 means infinite duration.
Definition: BaseParticleEmitter.hh:265
virtual double ScaleRate() const override
Get the amount by which to scale the particles in both x and y direction per second. Default value is 1.
Definition: BaseParticleEmitter.hh:383
virtual void PreRender() override
Prepare this object and any of its children for rendering. This should be called for each object in a...
Definition: BaseParticleEmitter.hh:216
Represents a surface material of a Geometry.
Definition: Material.hh:47
virtual double Lifetime() const override
Get the number of seconds each particle will ’live’ for before being destroyed. ...
Definition: BaseParticleEmitter.hh:308
virtual EmitterType Type() const override
Get the emitter type.
Definition: BaseParticleEmitter.hh:222
A base implementation of the ParticleEmitter class.
Definition: BaseParticleEmitter.hh:37