IParticleEmitter.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_EMITTER_H_INCLUDED__
#define __I_PARTICLE_EMITTER_H_INCLUDED__

#include "IAttributeExchangingObject.h"
#include "SParticle.h"

namespace irr
{
namespace scene
{

enum E_PARTICLE_EMITTER_TYPE
{
    EPET_POINT = 0,
    EPET_ANIMATED_MESH,
    EPET_BOX,
    EPET_CYLINDER,
    EPET_MESH,
    EPET_RING,
    EPET_SPHERE,
    EPET_COUNT
};

const c8* const ParticleEmitterTypeNames[] =
{
    "Point",
    "AnimatedMesh",
    "Box",
    "Cylinder",
    "Mesh",
    "Ring",
    "Sphere",
    0
};


class IParticleEmitter : public virtual io::IAttributeExchangingObject
{
public:


    virtual s32 emitt(u32 now, u32 timeSinceLastCall, SParticle*& outArray) = 0;

    virtual void setDirection( const core::vector3df& newDirection ) = 0;

    virtual void setMinParticlesPerSecond( u32 minPPS ) = 0;

    virtual void setMaxParticlesPerSecond( u32 maxPPS ) = 0;

    virtual void setMinStartColor( const video::SColor& color ) = 0;

    virtual void setMaxStartColor( const video::SColor& color ) = 0;

    virtual void setMaxStartSize( const core::dimension2df& size ) = 0;

    virtual void setMinStartSize( const core::dimension2df& size ) = 0;

    virtual void setMinLifeTime( u32 lifeTimeMin ) = 0;

    virtual void setMaxLifeTime( u32 lifeTimeMax ) = 0;

    virtual void setMaxAngleDegrees( s32 maxAngleDegrees ) = 0;

    virtual const core::vector3df& getDirection() const = 0;

    virtual u32 getMinParticlesPerSecond() const = 0;

    virtual u32 getMaxParticlesPerSecond() const = 0;

    virtual const video::SColor& getMinStartColor() const = 0;

    virtual const video::SColor& getMaxStartColor() const = 0;

    virtual const core::dimension2df& getMaxStartSize() const = 0;

    virtual const core::dimension2df& getMinStartSize() const = 0;

    virtual u32 getMinLifeTime() const = 0;

    virtual u32 getMaxLifeTime() const = 0;

    virtual s32 getMaxAngleDegrees() const = 0;


    virtual E_PARTICLE_EMITTER_TYPE getType() const { return EPET_POINT; }
};

typedef IParticleEmitter IParticlePointEmitter;

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


#endif