components/scene/ParticleSysComponent.h

Go to the documentation of this file.

// /////////////////////////////////////////////////////////////////////////////
//
// Name:            ParticleSysComponent.h
// Author:          Michael Bartsch (ZCCdark203)
//
// Desc :           Declaration of the ParticleSysComponent class.
//
// License:         Copyright (C) 2009 Michael Bartsch and Contributors
//
//                  This program is free software: you can redistribute it
//                  and/or modify it under the terms of the zlib/libpng License.
//                  See main.cpp for conditions of distribution and use.
//
// /////////////////////////////////////////////////////////////////////////////

#ifndef __PARTICLESYSCOMPONENT_H__
#define __PARTICLESYSCOMPONENT_H__

// Include files
#include "../../dependencies.h"
#include "SceneComponent.h"


// ParticleSysComponent class
class ParticleSysComponent : public SceneComponent
{
public:

    // Initialisation and deinitialisation
    ParticleSysComponent(Entity *parent, const vector3df &rotation = vector3df(0, 0, 0),
                         const vector3df &scale = vector3df(1.0f, 1.0f, 1.0f));
    ~ParticleSysComponent();

    // AngelScript binding
    static ParticleSysComponent* refFactory(Entity *parent, const vector3df &rotation,
                                            const vector3df &scale);

    // Methods
    IParticleSystemSceneNode* getParticleSystemSceneNode();

    void addAffector(IParticleAffector *affector);

    void addAttractionAffector(const vector3df &point, f32 speed = 1.0f, bool attract = true,
                               bool affectX = true, bool affectY = true, bool affectZ = true);

    void addFadeOutParticleAffector(const SColor &targetColor = SColor(0, 0, 0, 0),
                                    u32 timeNeededToFadeOut = 1000);

    void addGravityAffector(const vector3df &gravity = vector3df(0.0f,-0.03f, 0.0f),
                            u32 timeForceLost = 1000);

    void addRotationAffector(const vector3df &speed = vector3df(5.0f, 5.0f, 5.0f),
                             const vector3df &pivotPoint = vector3df(0.0f, 0.0f, 0.0f));

    void addScaleParticleAffector(const dimension2df &scaleTo = dimension2df(1.0f, 1.0f));

    void removeAffectors();

    IParticleEmitter* getEmitter();

    void setAnimatedMeshSceneNodeEmitter(const std::string &fileName,
                                         bool useNormalDirection = true,
                                         const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                                         f32 normalDirectionModifier = 100.0f,
                                         bool everyMeshVertex = false,
                                         u32 minParticlesPerSecond = 5,
                                         u32 maxParticlesPerSecond = 10,
                                         const SColor &minStartColor = SColor(255, 0, 0, 0),
                                         const SColor &maxStartColor = SColor(255, 255, 255, 255),
                                         u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000,
                                         s32 maxAngleDegrees = 0,
                                         const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                                         const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));
    void setAnimatedMeshSceneNodeEmitter(IAnimatedMeshSceneNode *node,
                                         bool useNormalDirection = true,
                                         const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                                         f32 normalDirectionModifier = 100.0f,
                                         bool everyMeshVertex = false,
                                         u32 minParticlesPerSecond = 5,
                                         u32 maxParticlesPerSecond = 10,
                                         const SColor &minStartColor = SColor(255, 0, 0, 0),
                                         const SColor &maxStartColor = SColor(255, 255, 255, 255),
                                         u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000,
                                         s32 maxAngleDegrees = 0,
                                         const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                                         const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));

    void setBoxEmitter(const aabbox3df &box = aabbox3df(-10, 28,-10, 10, 30, 10),
                       const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                       u32 minParticlesPerSecond = 5, u32 maxParticlesPerSecond = 10,
                       const SColor &minStartColor = SColor(255, 0, 0, 0),
                       const SColor &maxStartColor = SColor(255, 255, 255, 255),
                       u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000, s32 maxAngleDegrees = 0,
                       const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                       const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));

    void setCylinderEmitter(const vector3df &center, f32 radius, const vector3df &normal,
                            f32 length, bool outlineOnly = false,
                            const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                            u32 minParticlesPerSecond = 5, u32 maxParticlesPerSecond = 10,
                            const SColor &minStartColor = SColor(255, 0, 0, 0),
                            const SColor &maxStartColor = SColor(255, 255, 255, 255),
                            u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000, s32 maxAngleDegrees = 0,
                            const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                            const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));

    void setEmitter(IParticleEmitter *emitter);

    void setMeshEmitter(const std::string &fileName, bool useNormalDirection = true,
                        const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                        f32 normalDirectionModifier = 100.0f, bool everyMeshVertex = false,
                        u32 minParticlesPerSecond = 5, u32 maxParticlesPerSecond = 10,
                        const SColor &minStartColor = SColor(255, 0, 0, 0),
                        const SColor &maxStartColor = SColor(255, 255, 255, 255),
                        u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000, s32 maxAngleDegrees = 0,
                        const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                        const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));
    void setMeshEmitter(IMesh *mesh, bool useNormalDirection = true,
                        const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                        f32 normalDirectionModifier = 100.0f, bool everyMeshVertex = false,
                        u32 minParticlesPerSecond = 5, u32 maxParticlesPerSecond = 10,
                        const SColor &minStartColor = SColor(255, 0, 0, 0),
                        const SColor &maxStartColor = SColor(255, 255, 255, 255),
                        u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000, s32 maxAngleDegrees = 0,
                        const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                        const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));

    void setPointEmitter(const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                         u32 minParticlesPerSecond = 5, u32 maxParticlesPerSecond = 10,
                         const SColor &minStartColor = SColor(255, 0, 0, 0),
                         const SColor &maxStartColor = SColor(255, 255, 255, 255),
                         u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000, s32 maxAngleDegrees = 0,
                         const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                         const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));

    void setRingEmitter(const vector3df &center, f32 radius, f32 ringThickness,
                        const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                        u32 minParticlesPerSecond = 5, u32 maxParticlesPerSecond = 10,
                        const SColor &minStartColor = SColor(255, 0, 0, 0),
                        const SColor &maxStartColor = SColor(255, 255, 255, 255),
                        u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000, s32 maxAngleDegrees = 0,
                        const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                        const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));

    void setSphereEmitter(const vector3df &center, f32 radius,
                          const vector3df &direction = vector3df(0.0f, 0.03f, 0.0f),
                          u32 minParticlesPerSecond = 5, u32 maxParticlesPerSecond = 10,
                          const SColor &minStartColor = SColor(255, 0, 0, 0),
                          const SColor &maxStartColor = SColor(255, 255, 255, 255),
                          u32 lifeTimeMin = 2000, u32 lifeTimeMax = 4000, s32 maxAngleDegrees = 0,
                          const dimension2df &minStartSize = dimension2df(5.0f, 5.0f),
                          const dimension2df &maxStartSize = dimension2df(5.0f, 5.0f));

    void setParticlesAreGlobal(bool value = true);
    void setParticleSize(const dimension2df &size = dimension2df(5.0f, 5.0f));

private:

    // Members
    IParticleSystemSceneNode *mParticleSystemSN;
};


// ParticleSysComponent Angelscript binding.
extern void bindParticleSysComponent(asIScriptEngine *engine);

#endif

---