OgreParticle.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __Particle_H__
#define __Particle_H__

#include "OgrePrerequisites.h"
#include "OgreBillboard.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {

    class _OgreExport ParticleVisualData : public FXAlloc
    {
    public:
        ParticleVisualData() {}
        virtual ~ParticleVisualData() {}

    };

    class _OgreExport Particle : public FXAlloc
    {
    protected:
        ParticleSystem* mParentSystem;
        ParticleVisualData* mVisual;
    public:
        enum ParticleType
        {
            Visual,
            Emitter
        };

        bool mOwnDimensions;
        Real mWidth;
        Real mHeight;
        Radian rotation;
        // Note the intentional public access to internal variables
        // Accessing via get/set would be too costly for 000's of particles
        Vector3 position;
        Vector3 direction;
        ColourValue colour;
        Real timeToLive;
        Real totalTimeToLive;
        Radian rotationSpeed;
        ParticleType particleType;

        Particle()
            : mParentSystem(0), mVisual(0), mOwnDimensions(false), rotation(0), 
            position(Vector3::ZERO), direction(Vector3::ZERO), 
            colour(ColourValue::White), timeToLive(10), totalTimeToLive(10), 
            rotationSpeed(0), particleType(Visual)
        {
        }

        void setDimensions(Real width, Real height); 

        bool hasOwnDimensions(void) const { return mOwnDimensions; }

        Real getOwnWidth(void) const { return mWidth; }

        Real getOwnHeight(void) const { return mHeight; }
        
        void setRotation(const Radian& rad);

        const Radian& getRotation(void) const { return rotation; }

        void _notifyOwner(ParticleSystem* owner);

        void _notifyVisualData(ParticleVisualData* vis) { mVisual = vis; }

        ParticleVisualData* getVisualData(void) const { return mVisual; }

        void resetDimensions(void);
    };
}

#include "OgreHeaderSuffix.h"

#endif