Class to manage a particle emitter. More...

#include <Ogre2ParticleEmitter.hh>

Public Member Functions
virtual	~Ogre2ParticleEmitter ()
	Destructor.

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

virtual void	PreRender () override
	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.

virtual void	SetColorRange (const gz::math::Color &_colorStart, const gz::math::Color &_colorEnd) override
	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().

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 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().

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.

virtual void	SetEmitterSize (const gz::math::Vector3d &_size) override
	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:

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

virtual void	SetLifetime (double _lifetime) override
	Set the number of seconds each particle will ’live’ for before being destroyed. Default value is 5.

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

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

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

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

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

virtual void	SetVelocityRange (double _minVelocity, double _maxVelocity) override
	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.

Public Member Functions inherited from BaseParticleEmitter< Ogre2Visual >
virtual	~BaseParticleEmitter ()
	Destructor.

virtual gz::math::Color	ColorEnd () const override
	Get the end color of the particles.

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

virtual gz::math::Color	ColorStart () const override
	Get the starting color of the particles.

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

virtual gz::math::Vector3d	EmitterSize () const override
	Get the size of the emitter where the particles are sampled.

virtual bool	Emitting () const override
	Is the particle emitter enabled?

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

virtual MaterialPtr	Material () const override
	Get the material assigned to attached visuals and geometries.

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

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

virtual float	ParticleScatterRatio () const override
	Get the particle scatter ratio.

virtual gz::math::Vector3d	ParticleSize () const override
	Get the particle dimensions (width, height, depth).

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

virtual void	Reset ()
	Reset the particle emitter visual state.

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.

virtual void	SetParticleScatterRatio (float _ratio) override
	Set the particle scatter ratio.

virtual EmitterType	Type () const override
	Get the emitter type.

Public Member Functions inherited from ParticleEmitter
virtual	~ParticleEmitter ()
	Destructor.

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

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

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

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.

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.

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

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

Public Member Functions inherited from Ogre2Visual
virtual	~Ogre2Visual ()
	Destructor.

virtual gz::math::AxisAlignedBox	BoundingBox () const override
	Get the bounding box in world frame coordinates.

virtual gz::math::AxisAlignedBox	LocalBoundingBox () const override
	Get the local bounding box of the visual.

virtual void	SetStatic (bool _static) override
	Tells Render Engine this Visual will be static (i.e. won't move, rotate or scale) You can still move, rotate or scale the Visual; however doing so has a performance impact. How much of an impact will depend on the rendering backend being used.

virtual void	SetVisibilityFlags (uint32_t _flags) override
	Set visibility flags.

virtual void	SetVisible (bool _visible) override
	Specify if this visual is visible.

virtual void	SetWireframe (bool _show) override
	Enable or disable wireframe.

virtual bool	Static () const override
	Get whether the visual is static.

virtual bool	Wireframe () const override
	Get whether wireframe is enabled for this visual.

Public Member Functions inherited from BaseVisual< Ogre2Node >
virtual	~BaseVisual ()

virtual void	AddGeometry (GeometryPtr _geometry) override
	Add the given geometry to this visual. If the given node is already attached, no work will be done.

virtual void	AddVisibilityFlags (uint32_t _flags) override
	Add visibility flags.

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

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

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

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

virtual math::Pose3d	LocalPose () const override
	Get the local pose.

virtual void	RemoveGeometries () override
	Remove all attached geometries from this visual.

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

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

virtual void	RemoveVisibilityFlags (uint32_t _flags) override
	Remove visibility flags.

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

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

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

virtual void	SetMaterial (const std::string &_name, bool _unique=true) override
	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.

virtual uint32_t	VisibilityFlags () const override
	Get visibility flags.

Public Member Functions inherited from Ogre2Node
virtual	~Ogre2Node ()
	Destructor.

virtual bool	HasParent () const override
	Determine if this Node is attached to another Node.

virtual bool	InheritScale () const override
	Determine if this node inherits scale from this parent.

virtual math::Vector3d	LocalScale () const override
	Get the local scale.

virtual Ogre::SceneNode *	Node () const
	Get a pointer to the underlying scene node.

virtual NodePtr	Parent () const override
	Get the parent Node.

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

Public Member Functions inherited from BaseNode< Ogre2Object >
virtual	~BaseNode ()

virtual void	AddChild (NodePtr _child) override
	Add the given node to this node. If the given node is already a child, no work will be done.

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

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

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

virtual unsigned int	ChildCount () const override
	Get number of child nodes.

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

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

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

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

virtual math::Pose3d	InitialLocalPose () const override
	Get the initial local pose.

virtual math::Vector3d	LocalPosition () const override
	Get the local position.

virtual math::Quaterniond	LocalRotation () const override
	Get the local rotation.

virtual math::Vector3d	Origin () const override
	Get position of origin.

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

virtual NodePtr	RemoveChildById (unsigned int _id) override
	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.

virtual NodePtr	RemoveChildByIndex (unsigned int _index) override
	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.

virtual NodePtr	RemoveChildByName (const std::string &_name) override
	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.

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

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

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

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

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

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

virtual void	SetLocalPosition (double _x, double _y, double _z) override
	Set the local position.

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

virtual void	SetLocalRotation (double _r, double _p, double _y) override
	Set the local rotation.

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

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

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

virtual void	SetLocalScale (double _x, double _y, double _z) override
	Set the local scale.

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

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

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

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

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

virtual void	SetWorldPosition (double _x, double _y, double _z) override
	Set the world position.

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

virtual void	SetWorldRotation (double _r, double _p, double _y) override
	Set the world rotation.

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

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

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

virtual void	SetWorldScale (double _x, double _y, double _z) override
	Set the world scale.

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

virtual math::Pose3d	WorldPose () const override
	Get the world pose.

virtual math::Vector3d	WorldPosition () const override
	Get the world position.

virtual math::Quaterniond	WorldRotation () const override
	Get the world rotation.

virtual math::Vector3d	WorldScale () const override
	Get the world scale.

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

Public Member Functions inherited from Ogre2Object
virtual	~Ogre2Object ()
	Destructor.

virtual ScenePtr	Scene () const override

Public Member Functions inherited from BaseObject
virtual	~BaseObject ()

virtual unsigned int	Id () const override

virtual std::string	Name () const override

virtual void	PostRender () override

Static Public Attributes
static const uint32_t	kParticleVisibilityFlags
	Particle system visibility flags.

Protected Member Functions
	Ogre2ParticleEmitter ()
	Constructor.

virtual void	Init () override
	Initialize the visual.

Protected Member Functions inherited from BaseParticleEmitter< Ogre2Visual >
	BaseParticleEmitter ()
	Constructor.

Protected Member Functions inherited from Ogre2Visual
	Ogre2Visual ()
	Constructor.

virtual bool	AttachGeometry (GeometryPtr _geometry) override

virtual bool	DetachGeometry (GeometryPtr _geometry) override

virtual GeometryStorePtr	Geometries () const override

Protected Member Functions inherited from BaseVisual< Ogre2Node >
	BaseVisual ()

virtual void	PreRenderChildren () override

virtual void	PreRenderGeometries ()

Protected Member Functions inherited from Ogre2Node
	Ogre2Node ()
	Constructor.

virtual bool	AttachChild (NodePtr _child) override

virtual NodeStorePtr	Children () const override

virtual bool	DetachChild (NodePtr _child) override

virtual void	Load () override

virtual math::Pose3d	RawLocalPose () const override

virtual math::Vector3d	RawLocalPosition () const
	Get the raw local position of the node.

virtual math::Quaterniond	RawLocalRotation () const
	Get the raw local rotation of the node.

virtual void	SetLocalScaleImpl (const math::Vector3d &_scale) override
	Implementation of the SetLocalScale function.

virtual void	SetParent (Ogre2NodePtr _parent)
	Set the parent node.

virtual void	SetRawLocalPose (const math::Pose3d &_Pose3d) override

virtual void	SetRawLocalPosition (const math::Vector3d &_position)
	Set the raw local position of the node.

virtual void	SetRawLocalRotation (const math::Quaterniond &_rotation)
	Set the raw local rotation of the node.

Protected Member Functions inherited from BaseNode< Ogre2Object >
	BaseNode ()

Protected Member Functions inherited from Ogre2Object
	Ogre2Object ()
	Constructor.

Protected Member Functions inherited from BaseObject
	BaseObject ()

Additional Inherited Members
Protected Attributes inherited from BaseParticleEmitter< Ogre2Visual >
gz::math::Color	colorEnd
	The end color of a particle to choose from.

std::string	colorRangeImage
	The color image.

gz::math::Color	colorStart
	The start color of a particle to choose from.

double	duration
	Duration of the emitter.

gz::math::Vector3d	emitterSize
	Emitter size.

bool	emitting
	Whether particle emitter is enabled or not.

double	lifetime
	Particle lifetime.

MaterialPtr	material
	Particle material.

double	maxVelocity
	The maximum velocity of each particle.

double	minVelocity
	The minimum velocity of each particle.

float	particleScatterRatio
	The particle scatter ratio. This is used to determine the ratio of particles that will be detected by sensors. Increasing the ratio increases the scatter of the particles, which means there is a higher chance of particles reflecting and interfering with depth sensing, making the emitter appear more dense. Decreasing the ratio decreases the scatter of the particles, making it appear less dense. This value should be > 0.

gz::math::Vector3d	particleSize
	Particle size.

double	rate
	Rate of emission.

double	scaleRate
	The scale rate.

EmitterType	type
	Emitter type.

Protected Attributes inherited from Ogre2Visual
Ogre2GeometryStorePtr	geometries
	Pointer to the attached geometries.

Protected Attributes inherited from BaseVisual< Ogre2Node >
gz::math::AxisAlignedBox	boundingBox
	The bounding box of the visual.

MaterialPtr	material
	Pointer to material assigned to this visual.

uint32_t	visibilityFlags
	Visual's visibility flags.

bool	wireframe
	True if wireframe mode is enabled else false.

Protected Attributes inherited from Ogre2Node
Ogre2NodeStorePtr	children
	A list of child nodes.

Ogre::SceneNode *	ogreNode = nullptr
	The underlying ogre scene node.

Ogre2NodePtr	parent
	Pointer to the parent ogre node.

Protected Attributes inherited from BaseNode< Ogre2Object >
gz::math::Pose3d	initialLocalPose
	Initial local pose for this node.

bool	initialLocalPoseSet
	Flag to indicate whether initial local pose is set for this node.

math::Vector3d	origin

std::map< std::string, Variant >	userData
	A map of custom key value data.

Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr	scene
	Pointer to the ogre scene.

Protected Attributes inherited from BaseObject
unsigned int	id

std::string	name

Detailed Description

Class to manage a particle emitter.

Constructor & Destructor Documentation

◆ Ogre2ParticleEmitter()

Ogre2ParticleEmitter ( )

protected

Constructor.

◆ ~Ogre2ParticleEmitter()

virtual ~Ogre2ParticleEmitter ( )

virtual

Destructor.

Member Function Documentation

◆ Destroy()

void Destroy ( )

overridevirtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Implements Object.

◆ Init()

virtual void Init ( )

overrideprotectedvirtual

Initialize the visual.

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ PreRender()

virtual void PreRender ( )

overridevirtual

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.

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetColorRange()

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

overridevirtual

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.

See also: ColorStart; ColorEnd

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetColorRangeImage()

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

overridevirtual

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.

See also: ColorRangeImage

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetDuration()

virtual void SetDuration ( double _duration )

overridevirtual

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).

See also: Duration

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetEmitterSize()

virtual void SetEmitterSize ( const gz::math::Vector3d & _size )

overridevirtual

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 cylinder. 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).

See also
EmitterSize

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetEmitting()

virtual void SetEmitting ( bool _enable )

overridevirtual

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.

See also: Emitting

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetLifetime()

virtual void SetLifetime ( double _lifetime )

overridevirtual

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

Parameters

[in] _lifetime Lifetime of each particle (seconds).

See also: Lifetime

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetMaterial()

virtual void SetMaterial	(	MaterialPtr	_material,
		bool	_unique = `true`
	)

overridevirtual

Set the material for all attached visuals and geometries.

Parameters

[in]	_material	Name of the material to be assigned
[in]	_unique	True if the specified material should be cloned

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetParticleSize()

virtual void SetParticleSize ( const gz::math::Vector3d & _size )

overridevirtual

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

Parameters

[in] _size Particle dimensions.

See also: ParticleSize

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetRate()

virtual void SetRate ( double _rate )

overridevirtual

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

Parameters

[in] _rate Particles per second.

See also: Rate

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetScaleRate()

virtual void SetScaleRate ( double _scaleRate )

overridevirtual

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

Parameters

[in] _scaleRate The scale rate.

See also: ScaleRate

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetType()

virtual void SetType ( const EmitterType _type )

overridevirtual

Set the emitter type. Default value is EM_POINT.

Parameters

[in] _type Emitter type.

See also: EmitterType.; Type.

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

◆ SetVelocityRange()

virtual void SetVelocityRange	(	double	_minVelocity,
		double	_maxVelocity
	)

overridevirtual

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.

See also: MinVelocity; MaxVelocity

Reimplemented from BaseParticleEmitter< Ogre2Visual >.

Member Data Documentation

◆ kParticleVisibilityFlags

const uint32_t kParticleVisibilityFlags

static

Particle system visibility flags.

The documentation for this class was generated from the following file:

Ogre2ParticleEmitter.hh

Gazebo Rendering

API Reference

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ogre2ParticleEmitter()

◆ ~Ogre2ParticleEmitter()

Member Function Documentation

◆ Destroy()

◆ Init()

◆ PreRender()

◆ SetColorRange()

◆ SetColorRangeImage()

◆ SetDuration()

◆ SetEmitterSize()

◆ SetEmitting()

◆ SetLifetime()

◆ SetMaterial()

◆ SetParticleSize()

◆ SetRate()

◆ SetScaleRate()

◆ SetType()

◆ SetVelocityRange()

Member Data Documentation

◆ kParticleVisibilityFlags