IParticleSystemSceneNode.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_PARTICLE_SYSTEM_SCENE_NODE_H_INCLUDED__
#define __I_PARTICLE_SYSTEM_SCENE_NODE_H_INCLUDED__

#include "ISceneNode.h"
#include "IParticleAnimatedMeshSceneNodeEmitter.h"
#include "IParticleBoxEmitter.h"
#include "IParticleCylinderEmitter.h"
#include "IParticleMeshEmitter.h"
#include "IParticleRingEmitter.h"
#include "IParticleSphereEmitter.h"
#include "IParticleAttractionAffector.h"
#include "IParticleFadeOutAffector.h"
#include "IParticleGravityAffector.h"
#include "IParticleRotationAffector.h"
#include "dimension2d.h"

namespace irr
{
namespace scene
{


enum EParticleBehavior
{
        EPB_INVISIBLE_EMITTING = 1,

        EPB_INVISIBLE_AFFECTING = 2,

        EPB_INVISIBLE_ANIMATING = 4,

        EPB_CLEAR_ON_INVISIBLE = 8,

        EPB_EMITTER_VECTOR_IGNORE_ROTATION = 16,

        EPB_EMITTER_FRAME_INTERPOLATION = 32
};

class IParticleSystemSceneNode : public ISceneNode
{
public:

        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))
                        : ISceneNode(parent, mgr, id, position, rotation, scale)
                        , ParticleBehavior(0)
        {
        }

        virtual void setParticleSize(
                const core::dimension2d<f32> &size = core::dimension2d<f32>(5.0f, 5.0f)) = 0;


        virtual void setParticlesAreGlobal(bool global=true) = 0;



        virtual void setParticleBehavior(irr::u32 flags)
        {
                ParticleBehavior = flags;
        }



        virtual irr::u32 getParticleBehavior() const
        {
                return ParticleBehavior;
        }

        virtual void clearParticles() = 0;


        virtual void doParticleSystem(u32 time) = 0;


        virtual IParticleEmitter* getEmitter() =0;


        virtual void setEmitter(IParticleEmitter* emitter) = 0;


        virtual void addAffector(IParticleAffector* affector) = 0;


        virtual const core::list<IParticleAffector*>& getAffectors() const = 0;

        virtual void removeAllAffectors() = 0;


        virtual IParticleAnimatedMeshSceneNodeEmitter* 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) ) = 0;


        virtual IParticleBoxEmitter* 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) ) = 0;


        virtual IParticleCylinderEmitter* 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) ) = 0;


        virtual IParticleMeshEmitter* 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) ) = 0;


        virtual IParticlePointEmitter* 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) ) = 0;


        virtual IParticleRingEmitter* 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) ) = 0;


        virtual IParticleSphereEmitter* 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) ) = 0;


        virtual IParticleAttractionAffector* createAttractionAffector(
                const core::vector3df& point, f32 speed = 1.0f, bool attract = true,
                bool affectX = true, bool affectY = true, bool affectZ = true) = 0;


        virtual IParticleAffector* createScaleParticleAffector(const core::dimension2df& scaleTo = core::dimension2df(1.0f, 1.0f)) = 0;


        virtual IParticleFadeOutAffector* createFadeOutParticleAffector(
                const video::SColor& targetColor = video::SColor(0,0,0,0),
                u32 timeNeededToFadeOut = 1000) = 0;


        virtual IParticleGravityAffector* createGravityAffector(
                const core::vector3df& gravity = core::vector3df(0.0f,-0.03f,0.0f),
                u32 timeForceLost = 1000) = 0;


        virtual IParticleRotationAffector* 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) ) = 0;

        virtual void serializeAttributes(io::IAttributes* out, io::SAttributeReadWriteOptions* options) const _IRR_OVERRIDE_
        {
                out->addInt("ParticleBehavior", ParticleBehavior);
        }

        virtual void deserializeAttributes(io::IAttributes* in, io::SAttributeReadWriteOptions* options) _IRR_OVERRIDE_
        {
                ParticleBehavior = in->getAttributeAsInt("ParticleBehavior", ParticleBehavior);
        }

protected:
        s32 ParticleBehavior;
};

} // end namespace scene
} // end namespace irr

#endif