# Ignition Rendering

## API Reference

6.3.1
ParticleEmitter Class Referenceabstract

Class to manage a particle emitter. More...

#include <ParticleEmitter.hh>

## Public Member Functions

virtual ~ParticleEmitter ()
Destructor. More...

virtual ignition::math::Color ColorEnd () const =0
Get the end color of the particles. More...

virtual std::string ColorRangeImage () const =0
Get the path to the color image used as an affector. More...

virtual ignition::math::Color ColorStart () const =0
Get the starting color of the particles. More...

virtual double Duration () const =0
Get the number of seconds the emitter is active. A value of 0 means infinite duration. More...

virtual ignition::math::Vector3d EmitterSize () const =0
Get the size of the emitter where the particles are sampled. More...

virtual bool Emitting () const =0
Is the particle emitter enabled? More...

virtual double Lifetime () const =0
Get the number of seconds each particle will ’live’ for before being destroyed. More...

virtual MaterialPtr Material () const =0
Get the material which all particles in the emitter will use. More...

virtual double MaxVelocity () const =0
Get the maximum velocity each particle is emitted (m/s). More...

virtual double MinVelocity () const =0
Get the minimum velocity each particle is emitted (m/s). More...

virtual float ParticleScatterRatio () const =0
Get the particle scatter ratio. More...

virtual ignition::math::Vector3d ParticleSize () const =0
Get the particle dimensions (width, height, depth). More...

virtual double Rate () const =0
Get how many particles per second should be emitted. More...

virtual double ScaleRate () const =0
Get the amount by which to scale the particles in both x and y direction per second. Default value is 1. More...

virtual void SetColorRange (const ignition::math::Color &_colorStart, const ignition::math::Color &_colorEnd)=0
Sets a color for all particle emitted. The actual color will be interpolated between these two colors Color::White is the default color for the particles unless a specific function is used. Note that this function overrides the particle colors set with SetColorRangeImage(). More...

virtual void SetColorRangeImage (const std::string &_image)=0
Set the path to the color image used as an affector. This affector modifies the color of particles in flight. The colors are taken from a specified image file. The range of color values begins from the left side of the image and move to the right over the lifetime of the particle, therefore only the horizontal dimension of the image is used. Note that this function overrides the particle colors set with SetColorRange(). More...

virtual void SetDuration (double _duration)=0
Set the number of seconds the emitter is active. A value of 0 means infinite duration. Default value is 0. More...

virtual void SetEmitterSize (const ignition::math::Vector3d &_size)=0
Set the size of the emitter where the particles are sampled. Default value is (1, 1, 1). Note that the interpretation of the emitter area varies depending on the emmiter type: More...

virtual void SetEmitting (bool _enable)=0
This is used to turn on or off particle emission. Default value is false. More...

Set the number of seconds each particle will ’live’ for before being destroyed. Default value is 5. More...

virtual void SetMaterial (const MaterialPtr &_material)=0
Sets the material which all particles in the emitter will use. More...

virtual void SetParticleScatterRatio (float _ratio)=0
Set the particle scatter ratio. More...

virtual void SetParticleSize (const ignition::math::Vector3d &_size)=0
Set the particle dimensions (width, height, depth). Default value is {1, 1, 1}. More...

virtual void SetRate (double _rate)=0
Set how many particles per second should be emitted. Default value is 10. More...

virtual void SetScaleRate (double _scaleRate)=0
Set the amount by which to scale the particles in both x and y direction per second. More...

virtual void SetType (const EmitterType _type)=0
Set the emitter type. Default value is EM_POINT. More...

virtual void SetVelocityRange (double _minVelocity, double _maxVelocity)=0
Set a velocity range and each particle is emitted with a random velocity within this range (m/s). Default value is 1 for both velocities. More...

virtual EmitterType Type () const =0
Get the emitter type. More...

Public Member Functions inherited from Visual
virtual ~Visual ()
Destructor. More...

Add the given geometry to this visual. If the given node is already attached, no work will be done. More...

virtual ignition::math::AxisAlignedBox BoundingBox () const =0
Get the bounding box in world frame coordinates. More...

virtual VisualPtr Clone (const std::string &_name, NodePtr _newParent) const =0
Clone the visual (and its children) with a new name. More...

virtual GeometryPtr GeometryByIndex (unsigned int _index) const =0
Get geometry at given index. If no geometry exists at given index, NULL will be returned. More...

virtual unsigned int GeometryCount () const =0
Get the number of geometries attached to this visual. More...

virtual bool HasGeometry (ConstGeometryPtr _geometry) const =0
Determine if given geometry is attached to this visual. More...

virtual ignition::math::AxisAlignedBox LocalBoundingBox () const =0
Get the local bounding box of the visual. More...

virtual void RemoveGeometries ()=0
Remove all attached geometries from this visual. More...

virtual GeometryPtr RemoveGeometry (GeometryPtr _geometry)=0
Remove the given geometry from this visual. If the given node is not a child of this visual, no work will be done. More...

virtual GeometryPtr RemoveGeometryByIndex (unsigned int _index)=0
Remove the geometry at the given index from this visual. If the specified node is not attached this visual, no work will be done. More...

virtual void RemoveVisibilityFlags (uint32_t _flags)=0
Remove visibility flags. More...

virtual void SetChildMaterial (MaterialPtr _material, bool _unique=true)=0
Set the material for all attached visuals only. More...

virtual void SetGeometryMaterial (MaterialPtr _material, bool _unique=true)=0
Set the material for all attached geometries only. More...

virtual void SetMaterial (const std::string &_name, bool _unique=true)=0
Set the material for all attached visuals and geometries. The specified material will be retrieved from Scene::Material using the given material name. If no material is registered with the given name, no work will be done. More...

virtual void SetMaterial (MaterialPtr _material, bool _unique=true)=0
Set the material for all attached visuals and geometries. More...

virtual void SetVisibilityFlags (uint32_t _flags)=0
Set visibility flags. More...

virtual void SetVisible (bool _visible)=0
Specify if this visual is visible. More...

virtual void SetWireframe (bool _show)=0
Enable or disable wireframe. More...

virtual uint32_t VisibilityFlags () const =0
Get visibility flags. More...

virtual bool Wireframe () const =0
Get whether wireframe is enabled for this visual. More...

Public Member Functions inherited from Node
virtual ~Node ()
Destructor. More...

Add the given node to this node. If the given node is already a child, no work will be done. More...

virtual NodePtr ChildById (unsigned int _id) const =0
Get node with given ID. If no child exists with given ID, NULL will be returned. More...

virtual NodePtr ChildByIndex (unsigned int _index) const =0
Get node at given index. If no child exists at given index, NULL will be returned. More...

virtual NodePtr ChildByName (const std::string &_name) const =0
Get node with given name. If no child exists with given name, NULL will be returned. More...

virtual unsigned int ChildCount () const =0
Get number of child nodes. More...

virtual bool HasChild (ConstNodePtr _child) const =0
Determine if given node is an attached child. More...

virtual bool HasChildId (unsigned int _id) const =0
Determine if node with given ID is an attached child. More...

virtual bool HasChildName (const std::string &_name) const =0
Determine if node with given name is an attached child. More...

virtual bool HasParent () const =0
Determine if this Node is attached to another Node. More...

virtual bool HasUserData (const std::string &_key) const =0
Check if node has custom data. More...

virtual bool InheritScale () const =0
Determine if this node inherits scale from this parent. More...

virtual math::Pose3d InitialLocalPose () const =0
Get the initial local pose. More...

virtual math::Pose3d LocalPose () const =0
Get the local pose. More...

virtual math::Vector3d LocalPosition () const =0
Get the local position. More...

virtual math::Quaterniond LocalRotation () const =0
Get the local rotation. More...

virtual math::Vector3d LocalScale () const =0
Get the local scale. More...

virtual math::Vector3d Origin () const =0
Get position of origin. More...

virtual NodePtr Parent () const =0
Get the parent Node. More...

virtual NodePtr RemoveChild (NodePtr _child)=0
Remove (detach) the given node from this node. If the given node is not a child of this node, no work will be done. More...

virtual NodePtr RemoveChildById (unsigned int _id)=0
Remove (detach) the node with the given ID from this node. If the specified node is not a child of this node, no work will be done. More...

virtual NodePtr RemoveChildByIndex (unsigned int _index)=0
Remove (detach) the node at the given index from this node. If the specified node is not a child of this node, no work will be done. More...

virtual NodePtr RemoveChildByName (const std::string &_name)=0
Remove (detach) the node with the given name from this node. If the specified node is not a child of this node, no work will be done. More...

virtual void RemoveChildren ()=0
Remove all child nodes from this node This detaches all the child nodes but does not destroy them. More...

virtual void RemoveParent ()=0
Detach this Node from its parent. If this Node does not have a parent, no work will be done. More...

virtual void Scale (double _scale)=0
Scale the current scale by the given scalar. The given scalar will be assigned to the x, y, and z coordinates. More...

virtual void Scale (double _x, double _y, double _z)=0
Scale the current scale by the given scalars. More...

virtual void Scale (const math::Vector3d &_scale)=0
Scale the current scale by the given scalars. More...

virtual void SetInheritScale (bool _inherit)=0
Specify if this node inherits scale from its parent. More...

virtual void SetLocalPose (const math::Pose3d &_pose)=0
Set the local pose. More...

virtual void SetLocalPosition (double _x, double _y, double _z)=0
Set the local position. More...

virtual void SetLocalPosition (const math::Vector3d &_position)=0
Set the local position. More...

virtual void SetLocalRotation (double _r, double _p, double _y)=0
Set the local rotation. More...

virtual void SetLocalRotation (double _w, double _x, double _y, double _z)=0
Set the local rotation. More...

virtual void SetLocalRotation (const math::Quaterniond &_rotation)=0
Set the local rotation. More...

virtual void SetLocalScale (double _scale)=0
Set the local scale. The given scale will be assigned to the x, y, and z coordinates. More...

virtual void SetLocalScale (double _x, double _y, double _z)=0
Set the local scale. More...

virtual void SetLocalScale (const math::Vector3d &_scale)=0
Set the local scale. More...

virtual void SetOrigin (double _x, double _y, double _z)=0
Set position of origin. The position should be relative to the original origin of the geometry. More...

virtual void SetOrigin (const math::Vector3d &_origin)=0
Set position of origin. The position should be relative to the original origin of the geometry. More...

virtual void SetUserData (const std::string &_key, Variant _value)=0
Store any custom data associated with this node. More...

virtual void SetWorldPose (const math::Pose3d &_pose)=0
Set the world pose. More...

virtual void SetWorldPosition (double _x, double _y, double _z)=0
Set the world position. More...

virtual void SetWorldPosition (const math::Vector3d &_position)=0
Set the world position. More...

virtual void SetWorldRotation (double _r, double _p, double _y)=0
Set the world rotation. More...

virtual void SetWorldRotation (double _w, double _x, double _y, double _z)=0
Set the world rotation. More...

virtual void SetWorldRotation (const math::Quaterniond &_rotation)=0
Set the world rotation. More...

virtual void SetWorldScale (double _scale)=0
Set the world scale. The given scale will be assigned to the x, y, and z coordinates. More...

virtual void SetWorldScale (double _x, double _y, double _z)=0
Set the world scale. More...

virtual void SetWorldScale (const math::Vector3d &_scale)=0
Set the world scale. More...

virtual Variant UserData (const std::string &_key) const =0
Get custom data stored in this node. More...

virtual math::Pose3d WorldPose () const =0
Get the world pose. More...

virtual math::Vector3d WorldPosition () const =0
Get the world position. More...

virtual math::Quaterniond WorldRotation () const =0
Get the world rotation. More...

virtual math::Vector3d WorldScale () const =0
Get the world scale. More...

virtual math::Pose3d WorldToLocal (const math::Pose3d &_pose) const =0
Convert given world pose to local pose. More...

Public Member Functions inherited from Object
virtual ~Object ()
Destructor. More...

virtual void Destroy ()=0
Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...

virtual unsigned int Id () const =0
Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual std::string Name () const =0
Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes. More...

virtual void PostRender ()=0
Post process this object and any of its children after rendering. More...

virtual void PreRender ()=0
Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender. More...

virtual ScenePtr Scene () const =0
Get the Scene that created this object. More...

## Detailed Description

Class to manage a particle emitter.

## ◆ ColorEnd()

 virtual ignition::math::Color ColorEnd ( ) const
pure virtual

Get the end color of the particles.

Returns
End color.
ColorStart
SetColorRange

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ ColorRangeImage()

 virtual std::string ColorRangeImage ( ) const
pure virtual

Get the path to the color image used as an affector.

Returns
The color image name or empty string if the image is not set.
SetColorRangeImage

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ ColorStart()

 virtual ignition::math::Color ColorStart ( ) const
pure virtual

Get the starting color of the particles.

Returns
Start color.
ColorEnd
SetColorRange

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ Duration()

 virtual double Duration ( ) const
pure virtual

Get the number of seconds the emitter is active. A value of 0 means infinite duration.

Returns
Total duration of the emitter (seconds).
SetDuration

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ EmitterSize()

 virtual ignition::math::Vector3d EmitterSize ( ) const
pure virtual

Get the size of the emitter where the particles are sampled.

Returns
The emitter size. See SetEmitterSize() for the interpretation of the dimensions depending on the emitter type.
SetEmitterSize

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ Emitting()

 virtual bool Emitting ( ) const
pure virtual

Is the particle emitter enabled?

Returns
True when enabled or false otherwise.
SetEmitting

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

 virtual double Lifetime ( ) const
pure virtual

Get the number of seconds each particle will ’live’ for before being destroyed.

Returns

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ Material()

 virtual MaterialPtr Material ( ) const
pure virtual

Get the material which all particles in the emitter will use.

Returns
The material pointer.
SetMaterial

Implements Visual.

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ MaxVelocity()

 virtual double MaxVelocity ( ) const
pure virtual

Get the maximum velocity each particle is emitted (m/s).

Returns
Maximum velocity.
MinVelocity
SetVelocityRange

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ MinVelocity()

 virtual double MinVelocity ( ) const
pure virtual

Get the minimum velocity each particle is emitted (m/s).

Returns
Minimum velocity.
MaxVelocity
SetVelocityRange

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ ParticleScatterRatio()

 virtual float ParticleScatterRatio ( ) const
pure virtual

Get the particle scatter ratio.

Returns
The particle scatter ratio.
SetParticleScatterRatio

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ ParticleSize()

 virtual ignition::math::Vector3d ParticleSize ( ) const
pure virtual

Get the particle dimensions (width, height, depth).

Returns
Particle dimensions.
SetParticleSize

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ Rate()

 virtual double Rate ( ) const
pure virtual

Get how many particles per second should be emitted.

Returns
Particles per second.
SetRate

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ ScaleRate()

 virtual double ScaleRate ( ) const
pure virtual

Get the amount by which to scale the particles in both x and y direction per second. Default value is 1.

Returns
The scale rate.
SetScaleRate

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetColorRange()

 virtual void SetColorRange ( const ignition::math::Color & _colorStart, const ignition::math::Color & _colorEnd )
pure virtual

Sets a color for all particle emitted. The actual color will be interpolated between these two colors Color::White is the default color for the particles unless a specific function is used. Note that this function overrides the particle colors set with SetColorRangeImage().

Parameters
 [in] _colorStart Start color. [in] _colorEnd End color.
ColorStart
ColorEnd

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetColorRangeImage()

 virtual void SetColorRangeImage ( const std::string & _image )
pure virtual

Set the path to the color image used as an affector. This affector modifies the color of particles in flight. The colors are taken from a specified image file. The range of color values begins from the left side of the image and move to the right over the lifetime of the particle, therefore only the horizontal dimension of the image is used. Note that this function overrides the particle colors set with SetColorRange().

Parameters
 [in] _image The color image name.
ColorRangeImage

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetDuration()

 virtual void SetDuration ( double _duration )
pure virtual

Set the number of seconds the emitter is active. A value of 0 means infinite duration. Default value is 0.

Parameters
 [in] _duration Total duration of the emitter (seconds).
Duration

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetEmitterSize()

 virtual void SetEmitterSize ( const ignition::math::Vector3d & _size )
pure virtual

Set the size of the emitter where the particles are sampled. Default value is (1, 1, 1). Note that the interpretation of the emitter area varies depending on the emmiter type:

• EM_POINT: The area is ignored.
• EM_BOX: The area is interpreted as width X height X depth.
• EM_CYLINDER: The area is interpreted as the bounding box of the cilinder. The cylinder is oriented along the Z-axis.
• EM_ELLIPSOID: The area is interpreted as the bounding box of an ellipsoid shaped area, i.e. a sphere or squashed-sphere area. The parameters are again identical to EM_BOX, except that the dimensions describe the widest points along each of the axes.
Parameters
 [in] _size Size of the emitter (width, height, depth).
EmitterSize

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetEmitting()

 virtual void SetEmitting ( bool _enable )
pure virtual

This is used to turn on or off particle emission. Default value is false.

Parameters
 [in] _enable True for enabling the emission or false otherwise.
Emitting

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

pure virtual

Set the number of seconds each particle will ’live’ for before being destroyed. Default value is 5.

Parameters

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetMaterial()

 virtual void SetMaterial ( const MaterialPtr & _material )
pure virtual

Sets the material which all particles in the emitter will use.

Parameters
 [in] _material The material pointer.
Material

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetParticleScatterRatio()

 virtual void SetParticleScatterRatio ( float _ratio )
pure virtual

Set the particle scatter ratio.

Parameters
 [in] _ratio The scatter ratio. The particle emitter's scatter ratio will only be set to _ratio if _ratio > 0.
ParticleScatterRatio

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetParticleSize()

 virtual void SetParticleSize ( const ignition::math::Vector3d & _size )
pure virtual

Set the particle dimensions (width, height, depth). Default value is {1, 1, 1}.

Parameters
 [in] _size Particle dimensions.
ParticleSize

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetRate()

 virtual void SetRate ( double _rate )
pure virtual

Set how many particles per second should be emitted. Default value is 10.

Parameters
 [in] _rate Particles per second.
Rate

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetScaleRate()

 virtual void SetScaleRate ( double _scaleRate )
pure virtual

Set the amount by which to scale the particles in both x and y direction per second.

Parameters
 [in] _scaleRate The scale rate.
ScaleRate

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetType()

 virtual void SetType ( const EmitterType _type )
pure virtual

Set the emitter type. Default value is EM_POINT.

Parameters
 [in] _type Emitter type.
EmitterType.
Type.

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ SetVelocityRange()

 virtual void SetVelocityRange ( double _minVelocity, double _maxVelocity )
pure virtual

Set a velocity range and each particle is emitted with a random velocity within this range (m/s). Default value is 1 for both velocities.

Parameters
 [in] _minVelocity Minimum velocity. [in] _maxVelocity Maximum velocity.
MinVelocity
MaxVelocity

Implemented in BaseParticleEmitter< T >, and BaseParticleEmitter< OgreVisual >.

Referenced by ParticleEmitter::~ParticleEmitter().

## ◆ Type()

 virtual EmitterType Type ( ) const
pure virtual

Get the emitter type.

Returns
Emitter type.