A base implementation of the ParticleEmitter class. More...
#include <BaseParticleEmitter.hh>
Public Member Functions | |
virtual | ~BaseParticleEmitter () |
Destructor. More... | |
virtual ignition::math::Color | ColorEnd () const override |
Get the end color of the particles. More... | |
virtual std::string | ColorRangeImage () const override |
Get the path to the color image used as an affector. More... | |
virtual ignition::math::Color | ColorStart () const override |
Get the starting color of the particles. More... | |
virtual double | Duration () const override |
Get the number of seconds the emitter is active. A value of 0 means infinite duration. More... | |
virtual ignition::math::Vector3d | EmitterSize () const override |
Get the size of the emitter where the particles are sampled. More... | |
virtual bool | Emitting () const override |
Is the particle emitter enabled? More... | |
virtual void | Init () override |
virtual double | Lifetime () const override |
Get the number of seconds each particle will ’live’ for before being destroyed. More... | |
virtual MaterialPtr | Material () const override |
Get the material which all particles in the emitter will use. More... | |
virtual double | MaxVelocity () const override |
Get the maximum velocity each particle is emitted (m/s). More... | |
virtual double | MinVelocity () const override |
Get the minimum velocity each particle is emitted (m/s). More... | |
virtual float | ParticleScatterRatio () const override |
Get the particle scatter ratio. More... | |
virtual ignition::math::Vector3d | ParticleSize () const override |
Get the particle dimensions (width, height, depth). More... | |
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. More... | |
virtual double | Rate () const override |
Get how many particles per second should be emitted. More... | |
virtual void | Reset () |
Reset the particle emitter visual state. More... | |
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. More... | |
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 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) 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(). More... | |
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. More... | |
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, 1). Note that the interpretation of the emitter area varies depending on the emmiter type: More... | |
virtual void | SetEmitting (bool _enable) override |
This is used to turn on or off particle emission. Default value is false. More... | |
virtual void | SetLifetime (double _lifetime) override |
Set the number of seconds each particle will ’live’ for before being destroyed. Default value is 5. More... | |
virtual void | SetMaterial (const MaterialPtr &_material) override |
Sets the material which all particles in the emitter will use. More... | |
virtual void | SetParticleScatterRatio (float _ratio) override |
Set the particle scatter ratio. More... | |
virtual void | SetParticleSize (const ignition::math::Vector3d &_size) override |
Set the particle dimensions (width, height, depth). Default value is {1, 1, 1}. More... | |
virtual void | SetRate (double _rate) override |
Set how many particles per second should be emitted. Default value is 10. More... | |
virtual void | SetScaleRate (double _scaleRate) override |
Set the amount by which to scale the particles in both x and y direction per second. More... | |
virtual void | SetType (const EmitterType _type) override |
Set the emitter type. Default value is EM_POINT. More... | |
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. More... | |
virtual EmitterType | Type () const override |
Get the emitter type. More... | |
Public Member Functions inherited from ParticleEmitter | |
virtual | ~ParticleEmitter () |
Destructor. More... | |
Public Member Functions inherited from Visual | |
virtual | ~Visual () |
Destructor. More... | |
virtual void | AddGeometry (GeometryPtr _geometry)=0 |
Add the given geometry to this visual. If the given node is already attached, no work will be done. More... | |
virtual void | AddVisibilityFlags (uint32_t _flags)=0 |
Add visibility flags. More... | |
virtual ignition::math::AxisAlignedBox | BoundingBox () const =0 |
Get the bounding box in world frame coordinates. 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 MaterialPtr | Material ()=0 |
Get the material assigned to attached visuals and geometries. 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 | SetUserData (const std::string &_key, Variant _value)=0 |
Store any custom data associated with this visual. 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 Variant | UserData (const std::string &_key) const =0 |
Get custom data stored in this visual. More... | |
virtual uint32_t | VisibilityFlags () const =0 |
Get visibility flags. More... | |
Public Member Functions inherited from Node | |
virtual | ~Node () |
Destructor. More... | |
virtual void | AddChild (NodePtr _child)=0 |
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 | InheritScale () const =0 |
Determine if this visual inherits scale from this parent. 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 visual 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 | 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 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 ScenePtr | Scene () const =0 |
Get the Scene that created this object. More... | |
Protected Member Functions | |
BaseParticleEmitter () | |
Constructor. More... | |
Protected Attributes | |
ignition::math::Color | colorEnd |
The end color of a particle to choose from. More... | |
std::string | colorRangeImage = "" |
The color image. More... | |
ignition::math::Color | colorStart |
The start color of a particle to choose from. More... | |
double | duration = 0 |
Duration of the emitter. More... | |
ignition::math::Vector3d | emitterSize |
Emitter size. More... | |
bool | emitting = false |
Whether particle emitter is enabled or not. More... | |
double | lifetime = 5 |
Particle lifetime. More... | |
MaterialPtr | material = nullptr |
Particle material. More... | |
double | maxVelocity = 1 |
The maximum velocity of each particle. More... | |
double | minVelocity = 1 |
The minimum velocity of each particle. More... | |
float | particleScatterRatio = 0.65f |
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. More... | |
ignition::math::Vector3d | particleSize = {1, 1, 1} |
Particle size. More... | |
double | rate = 10 |
Rate of emission. More... | |
double | scaleRate = 1 |
The scale rate. More... | |
EmitterType | type = EM_POINT |
Emitter type. More... | |
Detailed Description
template<class T>
class ignition::rendering::BaseParticleEmitter< T >
A base implementation of the ParticleEmitter class.
Constructor & Destructor Documentation
◆ BaseParticleEmitter()
|
protected |
Constructor.
◆ ~BaseParticleEmitter()
|
virtual |
Destructor.
Member Function Documentation
◆ ColorEnd()
|
overridevirtual |
Get the end color of the particles.
- Returns
- End color.
- See also
- ColorStart
- SetColorRange
Implements ParticleEmitter.
◆ ColorRangeImage()
|
overridevirtual |
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.
- See also
- SetColorRangeImage
Implements ParticleEmitter.
◆ ColorStart()
|
overridevirtual |
Get the starting color of the particles.
- Returns
- Start color.
- See also
- ColorEnd
- SetColorRange
Implements ParticleEmitter.
◆ Duration()
|
overridevirtual |
Get the number of seconds the emitter is active. A value of 0 means infinite duration.
- Returns
- Total duration of the emitter (seconds).
- See also
- SetDuration
Implements ParticleEmitter.
◆ EmitterSize()
|
overridevirtual |
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.
- See also
- SetEmitterSize
Implements ParticleEmitter.
◆ Emitting()
|
overridevirtual |
Is the particle emitter enabled?
- Returns
- True when enabled or false otherwise.
- See also
- SetEmitting
Implements ParticleEmitter.
◆ Init()
|
overridevirtual |
Reimplemented in Ogre2ParticleEmitter.
◆ Lifetime()
|
overridevirtual |
Get the number of seconds each particle will ’live’ for before being destroyed.
- Returns
- Lifetime of each particle (seconds).
- See also
- SetLifetime
Implements ParticleEmitter.
◆ Material()
|
overridevirtual |
Get the material which all particles in the emitter will use.
- Returns
- The material pointer.
- See also
- SetMaterial
Implements ParticleEmitter.
◆ MaxVelocity()
|
overridevirtual |
Get the maximum velocity each particle is emitted (m/s).
- Returns
- Maximum velocity.
- See also
- MinVelocity
- SetVelocityRange
Implements ParticleEmitter.
◆ MinVelocity()
|
overridevirtual |
Get the minimum velocity each particle is emitted (m/s).
- Returns
- Minimum velocity.
- See also
- MaxVelocity
- SetVelocityRange
Implements ParticleEmitter.
◆ ParticleScatterRatio()
|
overridevirtual |
Get the particle scatter ratio.
- Returns
- The particle scatter ratio.
- See also
- SetParticleScatterRatio
Implements ParticleEmitter.
◆ ParticleSize()
|
overridevirtual |
Get the particle dimensions (width, height, depth).
- Returns
- Particle dimensions.
- See also
- SetParticleSize
Implements ParticleEmitter.
◆ 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.
Implements Object.
◆ Rate()
|
overridevirtual |
Get how many particles per second should be emitted.
- Returns
- Particles per second.
- See also
- SetRate
Implements ParticleEmitter.
◆ Reset()
|
virtual |
Reset the particle emitter visual state.
◆ ScaleRate()
|
overridevirtual |
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.
- See also
- SetScaleRate
Implements ParticleEmitter.
◆ SetColorRange()
|
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
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetColorRangeImage()
|
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
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetDuration()
|
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
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetEmitterSize()
|
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 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).
- See also
- EmitterSize
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetEmitting()
|
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
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetLifetime()
|
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
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetMaterial()
|
overridevirtual |
Sets the material which all particles in the emitter will use.
- Parameters
-
[in] _material The material pointer.
- See also
- Material
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetParticleScatterRatio()
|
overridevirtual |
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.
- See also
- ParticleScatterRatio
Implements ParticleEmitter.
◆ SetParticleSize()
|
overridevirtual |
Set the particle dimensions (width, height, depth). Default value is {1, 1, 1}.
- Parameters
-
[in] _size Particle dimensions.
- See also
- ParticleSize
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetRate()
|
overridevirtual |
Set how many particles per second should be emitted. Default value is 10.
- Parameters
-
[in] _rate Particles per second.
- See also
- Rate
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetScaleRate()
|
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
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetType()
|
overridevirtual |
Set the emitter type. Default value is EM_POINT.
- Parameters
-
[in] _type Emitter type.
- See also
- EmitterType.
- Type.
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ SetVelocityRange()
|
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
Implements ParticleEmitter.
Reimplemented in Ogre2ParticleEmitter.
◆ Type()
|
overridevirtual |
Get the emitter type.
- Returns
- Emitter type.
- See also
- EmitterType.
- SetType.
Implements ParticleEmitter.
Member Data Documentation
◆ colorEnd
|
protected |
The end color of a particle to choose from.
Referenced by BaseParticleEmitter< Ogre2Visual >::ColorEnd(), and BaseParticleEmitter< Ogre2Visual >::SetColorRange().
◆ colorRangeImage
|
protected |
The color image.
Referenced by BaseParticleEmitter< Ogre2Visual >::ColorRangeImage(), and BaseParticleEmitter< Ogre2Visual >::SetColorRangeImage().
◆ colorStart
|
protected |
The start color of a particle to choose from.
Referenced by BaseParticleEmitter< Ogre2Visual >::ColorStart(), and BaseParticleEmitter< Ogre2Visual >::SetColorRange().
◆ duration
|
protected |
Duration of the emitter.
Referenced by BaseParticleEmitter< Ogre2Visual >::Duration(), and BaseParticleEmitter< Ogre2Visual >::SetDuration().
◆ emitterSize
|
protected |
Emitter size.
Referenced by BaseParticleEmitter< Ogre2Visual >::EmitterSize(), and BaseParticleEmitter< Ogre2Visual >::SetEmitterSize().
◆ emitting
|
protected |
Whether particle emitter is enabled or not.
Referenced by BaseParticleEmitter< Ogre2Visual >::Emitting(), and BaseParticleEmitter< Ogre2Visual >::SetEmitting().
◆ lifetime
|
protected |
Particle lifetime.
Referenced by BaseParticleEmitter< Ogre2Visual >::Lifetime(), and BaseParticleEmitter< Ogre2Visual >::SetLifetime().
◆ material
|
protected |
Particle material.
Referenced by BaseParticleEmitter< Ogre2Visual >::Material(), and BaseParticleEmitter< Ogre2Visual >::SetMaterial().
◆ maxVelocity
|
protected |
The maximum velocity of each particle.
Referenced by BaseParticleEmitter< Ogre2Visual >::MaxVelocity(), and BaseParticleEmitter< Ogre2Visual >::SetVelocityRange().
◆ minVelocity
|
protected |
The minimum velocity of each particle.
Referenced by BaseParticleEmitter< Ogre2Visual >::MinVelocity(), and BaseParticleEmitter< Ogre2Visual >::SetVelocityRange().
◆ particleScatterRatio
|
protected |
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.
Referenced by BaseParticleEmitter< Ogre2Visual >::ParticleScatterRatio(), and BaseParticleEmitter< Ogre2Visual >::SetParticleScatterRatio().
◆ particleSize
|
protected |
Particle size.
Referenced by BaseParticleEmitter< Ogre2Visual >::ParticleSize(), and BaseParticleEmitter< Ogre2Visual >::SetParticleSize().
◆ rate
|
protected |
Rate of emission.
Referenced by BaseParticleEmitter< Ogre2Visual >::Rate(), and BaseParticleEmitter< Ogre2Visual >::SetRate().
◆ scaleRate
|
protected |
The scale rate.
Referenced by BaseParticleEmitter< Ogre2Visual >::ScaleRate(), and BaseParticleEmitter< Ogre2Visual >::SetScaleRate().
◆ type
|
protected |
Emitter type.
Referenced by BaseParticleEmitter< Ogre2Visual >::SetType(), and BaseParticleEmitter< Ogre2Visual >::Type().
The documentation for this class was generated from the following file: