Irrlicht 3D Engine
irr::scene::IParticleSystemSceneNode Class Referenceabstract

#include <IParticleSystemSceneNode.h>

+ Inheritance diagram for irr::scene::IParticleSystemSceneNode:

Public Member Functions

 IParticleSystemSceneNode (ISceneNode *parent, ISceneManager *mgr, s32 id, const core::vector3df &position=core::vector3df(0, 0, 0), const core::vector3df &rotation=core::vector3df(0, 0, 0), const core::vector3df &scale=core::vector3df(1.0f, 1.0f, 1.0f))
 Constructor. More...
 
virtual void addAffector (IParticleAffector *affector)=0
 Adds new particle effector to the particle system. More...
 
virtual void clearParticles ()=0
 Remove all currently visible particles. More...
 
virtual IParticleAnimatedMeshSceneNodeEmittercreateAnimatedMeshSceneNodeEmitter (scene::IAnimatedMeshSceneNode *node, bool useNormalDirection=true, const core::vector3df &direction=core::vector3df(0.0f, 0.03f, 0.0f), f32 normalDirectionModifier=100.0f, s32 mbNumber=-1, bool everyMeshVertex=false, u32 minParticlesPerSecond=5, u32 maxParticlesPerSecond=10, const video::SColor &minStartColor=video::SColor(255, 0, 0, 0), const video::SColor &maxStartColor=video::SColor(255, 255, 255, 255), u32 lifeTimeMin=2000, u32 lifeTimeMax=4000, s32 maxAngleDegrees=0, const core::dimension2df &minStartSize=core::dimension2df(5.0f, 5.0f), const core::dimension2df &maxStartSize=core::dimension2df(5.0f, 5.0f))=0
 Creates a particle emitter for an animated mesh scene node. More...
 
virtual IParticleAttractionAffectorcreateAttractionAffector (const core::vector3df &point, f32 speed=1.0f, bool attract=true, bool affectX=true, bool affectY=true, bool affectZ=true)=0
 Creates a point attraction affector. More...
 
virtual IParticleBoxEmittercreateBoxEmitter (const core::aabbox3df &box=core::aabbox3df(-10, 28,-10, 10, 30, 10), const core::vector3df &direction=core::vector3df(0.0f, 0.03f, 0.0f), u32 minParticlesPerSecond=5, u32 maxParticlesPerSecond=10, const video::SColor &minStartColor=video::SColor(255, 0, 0, 0), const video::SColor &maxStartColor=video::SColor(255, 255, 255, 255), u32 lifeTimeMin=2000, u32 lifeTimeMax=4000, s32 maxAngleDegrees=0, const core::dimension2df &minStartSize=core::dimension2df(5.0f, 5.0f), const core::dimension2df &maxStartSize=core::dimension2df(5.0f, 5.0f))=0
 Creates a box particle emitter. More...
 
virtual IParticleCylinderEmittercreateCylinderEmitter (const core::vector3df &center, f32 radius, const core::vector3df &normal, f32 length, bool outlineOnly=false, const core::vector3df &direction=core::vector3df(0.0f, 0.03f, 0.0f), u32 minParticlesPerSecond=5, u32 maxParticlesPerSecond=10, const video::SColor &minStartColor=video::SColor(255, 0, 0, 0), const video::SColor &maxStartColor=video::SColor(255, 255, 255, 255), u32 lifeTimeMin=2000, u32 lifeTimeMax=4000, s32 maxAngleDegrees=0, const core::dimension2df &minStartSize=core::dimension2df(5.0f, 5.0f), const core::dimension2df &maxStartSize=core::dimension2df(5.0f, 5.0f))=0
 Creates a particle emitter for emitting from a cylinder. More...
 
virtual IParticleFadeOutAffectorcreateFadeOutParticleAffector (const video::SColor &targetColor=video::SColor(0, 0, 0, 0), u32 timeNeededToFadeOut=1000)=0
 Creates a fade out particle affector. More...
 
virtual IParticleGravityAffectorcreateGravityAffector (const core::vector3df &gravity=core::vector3df(0.0f,-0.03f, 0.0f), u32 timeForceLost=1000)=0
 Creates a gravity affector. More...
 
virtual IParticleMeshEmittercreateMeshEmitter (scene::IMesh *mesh, bool useNormalDirection=true, const core::vector3df &direction=core::vector3df(0.0f, 0.03f, 0.0f), f32 normalDirectionModifier=100.0f, s32 mbNumber=-1, bool everyMeshVertex=false, u32 minParticlesPerSecond=5, u32 maxParticlesPerSecond=10, const video::SColor &minStartColor=video::SColor(255, 0, 0, 0), const video::SColor &maxStartColor=video::SColor(255, 255, 255, 255), u32 lifeTimeMin=2000, u32 lifeTimeMax=4000, s32 maxAngleDegrees=0, const core::dimension2df &minStartSize=core::dimension2df(5.0f, 5.0f), const core::dimension2df &maxStartSize=core::dimension2df(5.0f, 5.0f))=0
 Creates a mesh particle emitter. More...
 
virtual IParticlePointEmittercreatePointEmitter (const core::vector3df &direction=core::vector3df(0.0f, 0.03f, 0.0f), u32 minParticlesPerSecond=5, u32 maxParticlesPerSecond=10, const video::SColor &minStartColor=video::SColor(255, 0, 0, 0), const video::SColor &maxStartColor=video::SColor(255, 255, 255, 255), u32 lifeTimeMin=2000, u32 lifeTimeMax=4000, s32 maxAngleDegrees=0, const core::dimension2df &minStartSize=core::dimension2df(5.0f, 5.0f), const core::dimension2df &maxStartSize=core::dimension2df(5.0f, 5.0f))=0
 Creates a point particle emitter. More...
 
virtual IParticleRingEmittercreateRingEmitter (const core::vector3df &center, f32 radius, f32 ringThickness, const core::vector3df &direction=core::vector3df(0.0f, 0.03f, 0.0f), u32 minParticlesPerSecond=5, u32 maxParticlesPerSecond=10, const video::SColor &minStartColor=video::SColor(255, 0, 0, 0), const video::SColor &maxStartColor=video::SColor(255, 255, 255, 255), u32 lifeTimeMin=2000, u32 lifeTimeMax=4000, s32 maxAngleDegrees=0, const core::dimension2df &minStartSize=core::dimension2df(5.0f, 5.0f), const core::dimension2df &maxStartSize=core::dimension2df(5.0f, 5.0f))=0
 Creates a ring particle emitter. More...
 
virtual IParticleRotationAffectorcreateRotationAffector (const core::vector3df &speed=core::vector3df(5.0f, 5.0f, 5.0f), const core::vector3df &pivotPoint=core::vector3df(0.0f, 0.0f, 0.0f))=0
 Creates a rotation affector. More...
 
virtual IParticleAffectorcreateScaleParticleAffector (const core::dimension2df &scaleTo=core::dimension2df(1.0f, 1.0f))=0
 Creates a scale particle affector. More...
 
virtual IParticleSphereEmittercreateSphereEmitter (const core::vector3df &center, f32 radius, const core::vector3df &direction=core::vector3df(0.0f, 0.03f, 0.0f), u32 minParticlesPerSecond=5, u32 maxParticlesPerSecond=10, const video::SColor &minStartColor=video::SColor(255, 0, 0, 0), const video::SColor &maxStartColor=video::SColor(255, 255, 255, 255), u32 lifeTimeMin=2000, u32 lifeTimeMax=4000, s32 maxAngleDegrees=0, const core::dimension2df &minStartSize=core::dimension2df(5.0f, 5.0f), const core::dimension2df &maxStartSize=core::dimension2df(5.0f, 5.0f))=0
 Creates a sphere particle emitter. More...
 
virtual void deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options) _IRR_OVERRIDE_
 Reads attributes of the scene node. More...
 
virtual void doParticleSystem (u32 time)=0
 Do manually update the particles. More...
 
virtual const core::list< IParticleAffector * > & getAffectors () const =0
 Get a list of all particle affectors. More...
 
virtual IParticleEmittergetEmitter ()=0
 Gets the particle emitter, which creates the particles. More...
 
virtual irr::u32 getParticleBehavior () const
 Gets how particles behave in different situations. More...
 
virtual void removeAllAffectors ()=0
 Removes all particle affectors in the particle system. More...
 
virtual void serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options) const _IRR_OVERRIDE_
 Writes attributes of the scene node. More...
 
virtual void setEmitter (IParticleEmitter *emitter)=0
 Sets the particle emitter, which creates the particles. More...
 
virtual void setParticleBehavior (irr::u32 flags)
 Bitflags to change the particle behavior. More...
 
virtual void setParticlesAreGlobal (bool global=true)=0
 Sets if the particles should be global. More...
 
virtual void setParticleSize (const core::dimension2d< f32 > &size=core::dimension2d< f32 >(5.0f, 5.0f))=0
 Sets the size of all particles. More...
 
- Public Member Functions inherited from irr::scene::ISceneNode
 ISceneNode (ISceneNode *parent, ISceneManager *mgr, s32 id=-1, const core::vector3df &position=core::vector3df(0, 0, 0), const core::vector3df &rotation=core::vector3df(0, 0, 0), const core::vector3df &scale=core::vector3df(1.0f, 1.0f, 1.0f))
 Constructor. More...
 
virtual ~ISceneNode ()
 Destructor. More...
 
virtual void addAnimator (ISceneNodeAnimator *animator)
 Adds an animator which should animate this node. More...
 
virtual void addChild (ISceneNode *child)
 Adds a child to this scene node. More...
 
virtual ISceneNodeclone (ISceneNode *newParent=0, ISceneManager *newManager=0)
 Creates a clone of this scene node and its children. More...
 
virtual core::vector3df getAbsolutePosition () const
 Gets the absolute position of the node in world coordinates. More...
 
virtual const core::matrix4getAbsoluteTransformation () const
 Get the absolute transformation of the node. Is recalculated every OnAnimate()-call. More...
 
const core::list< ISceneNodeAnimator * > & getAnimators () const
 Get a list of all scene node animators. More...
 
u32 getAutomaticCulling () const
 Gets the automatic culling state. More...
 
virtual const core::aabbox3d< f32 > & getBoundingBox () const =0
 Get the axis aligned, not transformed bounding box of this node. More...
 
const core::list< ISceneNode * > & getChildren () const
 Returns a const reference to the list of all children. More...
 
virtual s32 getID () const
 Get the id of the scene node. More...
 
virtual video::SMaterialgetMaterial (u32 num)
 Returns the material based on the zero based index i. More...
 
virtual u32 getMaterialCount () const
 Get amount of materials used by this scene node. More...
 
virtual const c8getName () const
 Returns the name of the node. More...
 
scene::ISceneNodegetParent () const
 Returns the parent of this scene node. More...
 
virtual const core::vector3dfgetPosition () const
 Gets the position of the node relative to its parent. More...
 
virtual core::matrix4 getRelativeTransformation () const
 Returns the relative transformation of the scene node. More...
 
virtual const core::vector3dfgetRotation () const
 Gets the rotation of the node relative to its parent. More...
 
virtual const core::vector3dfgetScale () const
 Gets the scale of the scene node relative to its parent. More...
 
virtual ISceneManagergetSceneManager (void) const
 Retrieve the scene manager for this node. More...
 
virtual const core::aabbox3d< f32getTransformedBoundingBox () const
 Get the axis aligned, transformed and animated absolute bounding box of this node. More...
 
virtual void getTransformedBoundingBoxEdges (core::array< core::vector3d< f32 > > &edges) const
 
virtual ITriangleSelectorgetTriangleSelector () const
 Returns the triangle selector attached to this scene node. More...
 
virtual ESCENE_NODE_TYPE getType () const
 Returns type of the scene node. More...
 
u32 isDebugDataVisible () const
 Returns if debug data like bounding boxes are drawn. More...
 
bool isDebugObject () const
 Returns if this scene node is a debug object. More...
 
virtual bool isTrulyVisible () const
 Check whether the node is truly visible, taking into accounts its parents' visibility. More...
 
virtual bool isVisible () const
 Returns whether the node should be visible (if all of its parents are visible). More...
 
virtual void OnAnimate (u32 timeMs)
 OnAnimate() is called just before rendering the whole scene. More...
 
virtual void OnRegisterSceneNode ()
 This method is called just before the rendering process of the whole scene. More...
 
virtual void remove ()
 Removes this scene node from the scene. More...
 
virtual void removeAll ()
 Removes all children of this scene node. More...
 
virtual void removeAnimator (ISceneNodeAnimator *animator)
 Removes an animator from this scene node. More...
 
virtual void removeAnimators ()
 Removes all animators from this scene node. More...
 
virtual bool removeChild (ISceneNode *child)
 Removes a child from this scene node. More...
 
virtual void render ()=0
 Renders the node. More...
 
void setAutomaticCulling (u32 state)
 Set a culling style or disable culling completely. More...
 
virtual void setDebugDataVisible (u32 state)
 Sets if debug data like bounding boxes should be drawn. More...
 
virtual void setID (s32 id)
 Sets the id of the scene node. More...
 
void setIsDebugObject (bool debugObject)
 Sets if this scene node is a debug object. More...
 
void setMaterialFlag (video::E_MATERIAL_FLAG flag, bool newvalue)
 Sets all material flags at once to a new value. More...
 
void setMaterialTexture (u32 textureLayer, video::ITexture *texture)
 Sets the texture of the specified layer in all materials of this scene node to the new texture. More...
 
void setMaterialType (video::E_MATERIAL_TYPE newType)
 Sets the material type of all materials in this scene node to a new material type. More...
 
virtual void setName (const c8 *name)
 Sets the name of the node. More...
 
virtual void setName (const core::stringc &name)
 Sets the name of the node. More...
 
virtual void setParent (ISceneNode *newParent)
 Changes the parent of the scene node. More...
 
virtual void setPosition (const core::vector3df &newpos)
 Sets the position of the node relative to its parent. More...
 
virtual void setRotation (const core::vector3df &rotation)
 Sets the rotation of the node relative to its parent. More...
 
virtual void setScale (const core::vector3df &scale)
 Sets the relative scale of the scene node. More...
 
virtual void setTriangleSelector (ITriangleSelector *selector)
 Sets the triangle selector of the scene node. More...
 
virtual void setVisible (bool isVisible)
 Sets if the node should be visible or not. More...
 
virtual void updateAbsolutePosition ()
 Updates the absolute position based on the relative and the parents position. More...
 
- Public Member Functions inherited from irr::IReferenceCounted
 IReferenceCounted ()
 Constructor. More...
 
virtual ~IReferenceCounted ()
 Destructor. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 

Protected Attributes

s32 ParticleBehavior
 
- Protected Attributes inherited from irr::scene::ISceneNode
core::matrix4 AbsoluteTransformation
 Absolute transformation of the node. More...
 
core::list< ISceneNodeAnimator * > Animators
 List of all animator nodes. More...
 
u32 AutomaticCullingState
 Automatic culling state. More...
 
core::list< ISceneNode * > Children
 List of all children of this node. More...
 
u32 DebugDataVisible
 Flag if debug data should be drawn, such as Bounding Boxes. More...
 
s32 ID
 ID of the node. More...
 
bool IsDebugObject
 Is debug object? More...
 
bool IsVisible
 Is the node visible? More...
 
core::stringc Name
 Name of the scene node. More...
 
ISceneNodeParent
 Pointer to the parent. More...
 
core::vector3df RelativeRotation
 Relative rotation of the scene node. More...
 
core::vector3df RelativeScale
 Relative scale of the scene node. More...
 
core::vector3df RelativeTranslation
 Relative translation of the scene node. More...
 
ISceneManagerSceneManager
 Pointer to the scene manager. More...
 
ITriangleSelectorTriangleSelector
 Pointer to the triangle selector. More...
 

Additional Inherited Members

- Protected Member Functions inherited from irr::scene::ISceneNode
void cloneMembers (ISceneNode *toCopyFrom, ISceneManager *newManager)
 A clone function for the ISceneNode members. More...
 
void setSceneManager (ISceneManager *newManager)
 
- Protected Member Functions inherited from irr::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

Definition at line 71 of file IParticleSystemSceneNode.h.

Constructor & Destructor Documentation

◆ IParticleSystemSceneNode()

irr::scene::IParticleSystemSceneNode::IParticleSystemSceneNode ( ISceneNode parent,
ISceneManager mgr,
s32  id,
const core::vector3df position = core::vector3df(0,0,0),
const core::vector3df rotation = core::vector3df(0,0,0),
const core::vector3df scale = core::vector3df(1.0f, 1.0f, 1.0f) 
)
inline

Constructor.

Definition at line 76 of file IParticleSystemSceneNode.h.

Member Function Documentation

◆ addAffector()

virtual void irr::scene::IParticleSystemSceneNode::addAffector ( IParticleAffector affector)
pure virtual

Adds new particle effector to the particle system.

A particle affector modifies the particles. For example, the FadeOut affector lets all particles fade out after some time. It is created and used in this way:

IParticleAffector* p = createFadeOutParticleAffector();
p->drop();

Please note that an affector is not necessary for the particle system to work.

Parameters
affectorNew affector.

◆ clearParticles()

virtual void irr::scene::IParticleSystemSceneNode::clearParticles ( )
pure virtual

Remove all currently visible particles.

◆ createAnimatedMeshSceneNodeEmitter()

virtual IParticleAnimatedMeshSceneNodeEmitter* irr::scene::IParticleSystemSceneNode::createAnimatedMeshSceneNodeEmitter ( scene::IAnimatedMeshSceneNode node,
bool  useNormalDirection = true,
const core::vector3df direction = core::vector3df(0.0f, 0.03f, 0.0f),
f32  normalDirectionModifier = 100.0f,
s32  mbNumber = -1,
bool  everyMeshVertex = false,
u32  minParticlesPerSecond = 5,
u32  maxParticlesPerSecond = 10,
const video::SColor minStartColor = video::SColor(255, 0, 0, 0),
const video::SColor maxStartColor = video::SColor(255, 255, 255, 255),
u32  lifeTimeMin = 2000,
u32  lifeTimeMax = 4000,
s32  maxAngleDegrees = 0,
const core::dimension2df minStartSize = core::dimension2df(5.0f, 5.0f),
const core::dimension2df maxStartSize = core::dimension2df(5.0f, 5.0f) 
)
pure virtual

Creates a particle emitter for an animated mesh scene node.

Parameters
nodePointer to the animated mesh scene node to emit particles from
useNormalDirectionIf true, the direction of each particle created will be the normal of the vertex that it's emitting from. The normal is divided by the normalDirectionModifier parameter, which defaults to 100.0f.
directionDirection and speed of particle emission.
normalDirectionModifierIf the emitter is using the normal direction then the normal of the vertex that is being emitted from is divided by this number.
mbNumberThis allows you to specify a specific meshBuffer for the IMesh* to emit particles from. The default value is -1, which means a random meshBuffer picked from all of the meshes meshBuffers will be selected to pick a random vertex from. If the value is 0 or greater, it will only pick random vertices from the meshBuffer specified by this value.
everyMeshVertexIf true, the emitter will emit between min/max particles every second, for every vertex in the mesh, if false, it will emit between min/max particles from random vertices in the mesh.
minParticlesPerSecondMinimal amount of particles emitted per second.
maxParticlesPerSecondMaximal amount of particles emitted per second.
minStartColorMinimal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
maxStartColorMaximal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
lifeTimeMinMinimal lifetime of a particle, in milliseconds.
lifeTimeMaxMaximal lifetime of a particle, in milliseconds.
maxAngleDegreesMaximal angle in degrees, the emitting direction of the particle will differ from the original direction.
minStartSizeMinimal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
maxStartSizeMaximal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
Returns
Pointer to the created particle emitter. To set this emitter as new emitter of this particle system, just call setEmitter(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createAttractionAffector()

virtual IParticleAttractionAffector* irr::scene::IParticleSystemSceneNode::createAttractionAffector ( const core::vector3df point,
f32  speed = 1.0f,
bool  attract = true,
bool  affectX = true,
bool  affectY = true,
bool  affectZ = true 
)
pure virtual

Creates a point attraction affector.

This affector modifies the positions of the particles and attracts them to a specified point at a specified speed per second.

Parameters
pointPoint to attract particles to.
speedSpeed in units per second, to attract to the specified point.
attractWhether the particles attract or detract from this point.
affectXWhether or not this will affect the X position of the particle.
affectYWhether or not this will affect the Y position of the particle.
affectZWhether or not this will affect the Z position of the particle.
Returns
Pointer to the created particle affector. To add this affector as new affector of this particle system, just call addAffector(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createBoxEmitter()

virtual IParticleBoxEmitter* irr::scene::IParticleSystemSceneNode::createBoxEmitter ( const core::aabbox3df box = core::aabbox3df(-10, 28,-10, 10, 30, 10),
const core::vector3df direction = core::vector3df(0.0f, 0.03f, 0.0f),
u32  minParticlesPerSecond = 5,
u32  maxParticlesPerSecond = 10,
const video::SColor minStartColor = video::SColor(255, 0, 0, 0),
const video::SColor maxStartColor = video::SColor(255, 255, 255, 255),
u32  lifeTimeMin = 2000,
u32  lifeTimeMax = 4000,
s32  maxAngleDegrees = 0,
const core::dimension2df minStartSize = core::dimension2df(5.0f, 5.0f),
const core::dimension2df maxStartSize = core::dimension2df(5.0f, 5.0f) 
)
pure virtual

Creates a box particle emitter.

Parameters
boxThe box for the emitter.
directionDirection and speed of particle emission.
minParticlesPerSecondMinimal amount of particles emitted per second.
maxParticlesPerSecondMaximal amount of particles emitted per second.
minStartColorMinimal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
maxStartColorMaximal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
lifeTimeMinMinimal lifetime of a particle, in milliseconds.
lifeTimeMaxMaximal lifetime of a particle, in milliseconds.
maxAngleDegreesMaximal angle in degrees, the emitting direction of the particle will differ from the original direction.
minStartSizeMinimal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
maxStartSizeMaximal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
Returns
Pointer to the created particle emitter. To set this emitter as new emitter of this particle system, just call setEmitter(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createCylinderEmitter()

virtual IParticleCylinderEmitter* irr::scene::IParticleSystemSceneNode::createCylinderEmitter ( const core::vector3df center,
f32  radius,
const core::vector3df normal,
f32  length,
bool  outlineOnly = false,
const core::vector3df direction = core::vector3df(0.0f, 0.03f, 0.0f),
u32  minParticlesPerSecond = 5,
u32  maxParticlesPerSecond = 10,
const video::SColor minStartColor = video::SColor(255, 0, 0, 0),
const video::SColor maxStartColor = video::SColor(255, 255, 255, 255),
u32  lifeTimeMin = 2000,
u32  lifeTimeMax = 4000,
s32  maxAngleDegrees = 0,
const core::dimension2df minStartSize = core::dimension2df(5.0f, 5.0f),
const core::dimension2df maxStartSize = core::dimension2df(5.0f, 5.0f) 
)
pure virtual

Creates a particle emitter for emitting from a cylinder.

Parameters
centerThe center of the circle at the base of the cylinder
radiusThe thickness of the cylinder
normalDirection of the length of the cylinder
lengthThe length of the the cylinder
outlineOnlyWhether or not to put points inside the cylinder or on the outline only
directionDirection and speed of particle emission.
minParticlesPerSecondMinimal amount of particles emitted per second.
maxParticlesPerSecondMaximal amount of particles emitted per second.
minStartColorMinimal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
maxStartColorMaximal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
lifeTimeMinMinimal lifetime of a particle, in milliseconds.
lifeTimeMaxMaximal lifetime of a particle, in milliseconds.
maxAngleDegreesMaximal angle in degrees, the emitting direction of the particle will differ from the original direction.
minStartSizeMinimal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
maxStartSizeMaximal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
Returns
Pointer to the created particle emitter. To set this emitter as new emitter of this particle system, just call setEmitter(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createFadeOutParticleAffector()

virtual IParticleFadeOutAffector* irr::scene::IParticleSystemSceneNode::createFadeOutParticleAffector ( const video::SColor targetColor = video::SColor(0, 0, 0, 0),
u32  timeNeededToFadeOut = 1000 
)
pure virtual

Creates a fade out particle affector.

This affector modifies the color of every particle and and reaches the final color when the particle dies. This affector looks really good, if the EMT_TRANSPARENT_ADD_COLOR material is used and the targetColor is video::SColor(0,0,0,0): Particles are fading out into void with this setting.

Parameters
targetColorColor whereto the color of the particle is changed.
timeNeededToFadeOutHow much time in milliseconds should the affector need to change the color to the targetColor.
Returns
Pointer to the created particle affector. To add this affector as new affector of this particle system, just call addAffector(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createGravityAffector()

virtual IParticleGravityAffector* irr::scene::IParticleSystemSceneNode::createGravityAffector ( const core::vector3df gravity = core::vector3df(0.0f,-0.03f, 0.0f),
u32  timeForceLost = 1000 
)
pure virtual

Creates a gravity affector.

This affector modifies the direction of the particle. It assumes that the particle is fired out of the emitter with huge force, but is loosing this after some time and is caught by the gravity then. This affector is ideal for creating things like fountains.

Parameters
gravityDirection and force of gravity.
timeForceLostTime in milliseconds when the force of the emitter is totally lost and the particle does not move any more. This is the time where gravity fully affects the particle.
Returns
Pointer to the created particle affector. To add this affector as new affector of this particle system, just call addAffector(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createMeshEmitter()

virtual IParticleMeshEmitter* irr::scene::IParticleSystemSceneNode::createMeshEmitter ( scene::IMesh mesh,
bool  useNormalDirection = true,
const core::vector3df direction = core::vector3df(0.0f, 0.03f, 0.0f),
f32  normalDirectionModifier = 100.0f,
s32  mbNumber = -1,
bool  everyMeshVertex = false,
u32  minParticlesPerSecond = 5,
u32  maxParticlesPerSecond = 10,
const video::SColor minStartColor = video::SColor(255, 0, 0, 0),
const video::SColor maxStartColor = video::SColor(255, 255, 255, 255),
u32  lifeTimeMin = 2000,
u32  lifeTimeMax = 4000,
s32  maxAngleDegrees = 0,
const core::dimension2df minStartSize = core::dimension2df(5.0f, 5.0f),
const core::dimension2df maxStartSize = core::dimension2df(5.0f, 5.0f) 
)
pure virtual

Creates a mesh particle emitter.

Parameters
meshPointer to mesh to emit particles from
useNormalDirectionIf true, the direction of each particle created will be the normal of the vertex that it's emitting from. The normal is divided by the normalDirectionModifier parameter, which defaults to 100.0f.
directionDirection and speed of particle emission.
normalDirectionModifierIf the emitter is using the normal direction then the normal of the vertex that is being emitted from is divided by this number.
mbNumberThis allows you to specify a specific meshBuffer for the IMesh* to emit particles from. The default value is -1, which means a random meshBuffer picked from all of the meshes meshBuffers will be selected to pick a random vertex from. If the value is 0 or greater, it will only pick random vertices from the meshBuffer specified by this value.
everyMeshVertexIf true, the emitter will emit between min/max particles every second, for every vertex in the mesh, if false, it will emit between min/max particles from random vertices in the mesh.
minParticlesPerSecondMinimal amount of particles emitted per second.
maxParticlesPerSecondMaximal amount of particles emitted per second.
minStartColorMinimal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
maxStartColorMaximal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
lifeTimeMinMinimal lifetime of a particle, in milliseconds.
lifeTimeMaxMaximal lifetime of a particle, in milliseconds.
maxAngleDegreesMaximal angle in degrees, the emitting direction of the particle will differ from the original direction.
minStartSizeMinimal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
maxStartSizeMaximal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
Returns
Pointer to the created particle emitter. To set this emitter as new emitter of this particle system, just call setEmitter(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createPointEmitter()

virtual IParticlePointEmitter* irr::scene::IParticleSystemSceneNode::createPointEmitter ( const core::vector3df direction = core::vector3df(0.0f, 0.03f, 0.0f),
u32  minParticlesPerSecond = 5,
u32  maxParticlesPerSecond = 10,
const video::SColor minStartColor = video::SColor(255, 0, 0, 0),
const video::SColor maxStartColor = video::SColor(255, 255, 255, 255),
u32  lifeTimeMin = 2000,
u32  lifeTimeMax = 4000,
s32  maxAngleDegrees = 0,
const core::dimension2df minStartSize = core::dimension2df(5.0f, 5.0f),
const core::dimension2df maxStartSize = core::dimension2df(5.0f, 5.0f) 
)
pure virtual

Creates a point particle emitter.

Parameters
directionDirection and speed of particle emission.
minParticlesPerSecondMinimal amount of particles emitted per second.
maxParticlesPerSecondMaximal amount of particles emitted per second.
minStartColorMinimal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
maxStartColorMaximal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
lifeTimeMinMinimal lifetime of a particle, in milliseconds.
lifeTimeMaxMaximal lifetime of a particle, in milliseconds.
maxAngleDegreesMaximal angle in degrees, the emitting direction of the particle will differ from the original direction.
minStartSizeMinimal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
maxStartSizeMaximal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
Returns
Pointer to the created particle emitter. To set this emitter as new emitter of this particle system, just call setEmitter(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createRingEmitter()

virtual IParticleRingEmitter* irr::scene::IParticleSystemSceneNode::createRingEmitter ( const core::vector3df center,
f32  radius,
f32  ringThickness,
const core::vector3df direction = core::vector3df(0.0f, 0.03f, 0.0f),
u32  minParticlesPerSecond = 5,
u32  maxParticlesPerSecond = 10,
const video::SColor minStartColor = video::SColor(255, 0, 0, 0),
const video::SColor maxStartColor = video::SColor(255, 255, 255, 255),
u32  lifeTimeMin = 2000,
u32  lifeTimeMax = 4000,
s32  maxAngleDegrees = 0,
const core::dimension2df minStartSize = core::dimension2df(5.0f, 5.0f),
const core::dimension2df maxStartSize = core::dimension2df(5.0f, 5.0f) 
)
pure virtual

Creates a ring particle emitter.

Parameters
centerCenter of ring
radiusDistance of points from center, points will be rotated around the Y axis at a random 360 degrees and will then be shifted by the provided ringThickness values in each axis.
ringThickness: thickness of the ring or how wide the ring is
directionDirection and speed of particle emission.
minParticlesPerSecondMinimal amount of particles emitted per second.
maxParticlesPerSecondMaximal amount of particles emitted per second.
minStartColorMinimal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
maxStartColorMaximal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
lifeTimeMinMinimal lifetime of a particle, in milliseconds.
lifeTimeMaxMaximal lifetime of a particle, in milliseconds.
maxAngleDegreesMaximal angle in degrees, the emitting direction of the particle will differ from the original direction.
minStartSizeMinimal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
maxStartSizeMaximal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
Returns
Pointer to the created particle emitter. To set this emitter as new emitter of this particle system, just call setEmitter(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createRotationAffector()

virtual IParticleRotationAffector* irr::scene::IParticleSystemSceneNode::createRotationAffector ( const core::vector3df speed = core::vector3df(5.0f, 5.0f, 5.0f),
const core::vector3df pivotPoint = core::vector3df(0.0f, 0.0f, 0.0f) 
)
pure virtual

Creates a rotation affector.

This affector modifies the positions of the particles and attracts them to a specified point at a specified speed per second.

Parameters
speedRotation in degrees per second
pivotPointPoint to rotate the particles around
Returns
Pointer to the created particle affector. To add this affector as new affector of this particle system, just call addAffector(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createScaleParticleAffector()

virtual IParticleAffector* irr::scene::IParticleSystemSceneNode::createScaleParticleAffector ( const core::dimension2df scaleTo = core::dimension2df(1.0f, 1.0f))
pure virtual

Creates a scale particle affector.

This affector scales the particle to the a multiple of its size defined by the scaleTo variable.

Parameters
scaleTomultiple of the size which the particle will be scaled to until deletion
Returns
Pointer to the created particle affector. To add this affector as new affector of this particle system, just call addAffector(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ createSphereEmitter()

virtual IParticleSphereEmitter* irr::scene::IParticleSystemSceneNode::createSphereEmitter ( const core::vector3df center,
f32  radius,
const core::vector3df direction = core::vector3df(0.0f, 0.03f, 0.0f),
u32  minParticlesPerSecond = 5,
u32  maxParticlesPerSecond = 10,
const video::SColor minStartColor = video::SColor(255, 0, 0, 0),
const video::SColor maxStartColor = video::SColor(255, 255, 255, 255),
u32  lifeTimeMin = 2000,
u32  lifeTimeMax = 4000,
s32  maxAngleDegrees = 0,
const core::dimension2df minStartSize = core::dimension2df(5.0f, 5.0f),
const core::dimension2df maxStartSize = core::dimension2df(5.0f, 5.0f) 
)
pure virtual

Creates a sphere particle emitter.

Parameters
centerCenter of sphere
radiusRadius of sphere
directionDirection and speed of particle emission.
minParticlesPerSecondMinimal amount of particles emitted per second.
maxParticlesPerSecondMaximal amount of particles emitted per second.
minStartColorMinimal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
maxStartColorMaximal initial start color of a particle. The real color of every particle is calculated as random interpolation between minStartColor and maxStartColor.
lifeTimeMinMinimal lifetime of a particle, in milliseconds.
lifeTimeMaxMaximal lifetime of a particle, in milliseconds.
maxAngleDegreesMaximal angle in degrees, the emitting direction of the particle will differ from the original direction.
minStartSizeMinimal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
maxStartSizeMaximal initial start size of a particle. The real size of every particle is calculated as random interpolation between minStartSize and maxStartSize.
Returns
Pointer to the created particle emitter. To set this emitter as new emitter of this particle system, just call setEmitter(). Note that you'll have to drop() the returned pointer, after you don't need it any more, see IReferenceCounted::drop() for more information.

◆ deserializeAttributes()

virtual void irr::scene::IParticleSystemSceneNode::deserializeAttributes ( io::IAttributes in,
io::SAttributeReadWriteOptions options 
)
inlinevirtual

Reads attributes of the scene node.

Reimplemented from irr::scene::ISceneNode.

Definition at line 560 of file IParticleSystemSceneNode.h.

References ParticleBehavior.

◆ doParticleSystem()

virtual void irr::scene::IParticleSystemSceneNode::doParticleSystem ( u32  time)
pure virtual

Do manually update the particles.

This should only be called when you want to render the node outside the scenegraph, as the node will care about this otherwise automatically.

◆ getAffectors()

virtual const core::list<IParticleAffector*>& irr::scene::IParticleSystemSceneNode::getAffectors ( ) const
pure virtual

Get a list of all particle affectors.

Returns
The list of particle affectors attached to this node.

◆ getEmitter()

virtual IParticleEmitter* irr::scene::IParticleSystemSceneNode::getEmitter ( )
pure virtual

Gets the particle emitter, which creates the particles.

Returns
The particle emitter. Can be 0 if none is set.

◆ getParticleBehavior()

virtual irr::u32 irr::scene::IParticleSystemSceneNode::getParticleBehavior ( ) const
inlinevirtual

Gets how particles behave in different situations.

Returns
A combination of EParticleBehavior flags

Definition at line 108 of file IParticleSystemSceneNode.h.

References ParticleBehavior.

◆ removeAllAffectors()

virtual void irr::scene::IParticleSystemSceneNode::removeAllAffectors ( )
pure virtual

Removes all particle affectors in the particle system.

◆ serializeAttributes()

virtual void irr::scene::IParticleSystemSceneNode::serializeAttributes ( io::IAttributes out,
io::SAttributeReadWriteOptions options 
) const
inlinevirtual

Writes attributes of the scene node.

Reimplemented from irr::scene::ISceneNode.

Definition at line 554 of file IParticleSystemSceneNode.h.

References ParticleBehavior.

◆ setEmitter()

virtual void irr::scene::IParticleSystemSceneNode::setEmitter ( IParticleEmitter emitter)
pure virtual

Sets the particle emitter, which creates the particles.

A particle emitter can be created using one of the createEmitter methods. For example to create and use a simple PointEmitter, call IParticleEmitter* p = createPointEmitter(); setEmitter(p); p->drop();

Parameters
emitterSets the particle emitter. You can set this to 0 for removing the current emitter and stopping the particle system emitting new particles.

◆ setParticleBehavior()

virtual void irr::scene::IParticleSystemSceneNode::setParticleBehavior ( irr::u32  flags)
inlinevirtual

Bitflags to change the particle behavior.

Parameters
flagsA combination of EParticleBehavior bit-flags. Default is 0.

Definition at line 99 of file IParticleSystemSceneNode.h.

References ParticleBehavior.

◆ setParticlesAreGlobal()

virtual void irr::scene::IParticleSystemSceneNode::setParticlesAreGlobal ( bool  global = true)
pure virtual

Sets if the particles should be global.

If they are, the particles are affected by the movement of the particle system scene node too, otherwise they completely ignore it. Default is true.

◆ setParticleSize()

virtual void irr::scene::IParticleSystemSceneNode::setParticleSize ( const core::dimension2d< f32 > &  size = core::dimension2df32 >(5.0f, 5.0f))
pure virtual

Sets the size of all particles.

Member Data Documentation

◆ ParticleBehavior

s32 irr::scene::IParticleSystemSceneNode::ParticleBehavior
protected

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