Lightning.h

Go to the documentation of this file.

/*
--------------------------------------------------------------------------------
This source file is part of SkyX.
Visit http://www.paradise-studios.net/products/skyx/

Copyright (C) 2009-2012 Xavier Verguín González <xavyiy@gmail.com>

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
--------------------------------------------------------------------------------
*/

#ifndef _SkyX_VClouds_Lightning_H_
#define _SkyX_VClouds_Lightning_H_

#include <vector>
#include "Prerequisites.h"

namespace SkyX { namespace VClouds {

  class DllExport Lightning
  {
    public:
      struct Segment
      {
        public:
          Segment()
            : a(Ogre::Vector3())
              , b(Ogre::Vector3())
        {
        }

          Segment(const Ogre::Vector3& a_, const Ogre::Vector3& b_)
            : a(a_)
              , b(b_)
        {
        }

          Ogre::Vector3 a;
          Ogre::Vector3 b;
      };

      Lightning(Ogre::SceneManager* sm, Ogre::SceneNode* sn,
          const Ogre::Vector3& orig, const Ogre::Vector3& dir,
          const Ogre::Real& l,
          const Ogre::uint32& d, const Ogre::uint32& rec,
          const Ogre::Real& tm,  const Ogre::Real& wm,
          const Ogre::Vector2& b = Ogre::Vector2(0, 1));

      ~Lightning();

      void create();

      void remove();

      void update(Ogre::Real timeSinceLastFrame);

      inline const Ogre::Vector3& getDirection() const
      {
        return mDirection;
      }

      inline const Ogre::Real& getLength() const
      {
        return mLength;
      }

      inline const Ogre::Real& getIntensity() const
      {
        return mIntensity;
      }

      inline Ogre::BillboardSet* getBillboardSet() const
      {
        return mBillboardSet;
      }

      inline Ogre::SceneNode* getSceneNode() const
      {
        return mSceneNode;
      }

      inline const bool& isFinished() const
      {
        return mFinished;
      }

      void _updateRenderQueueGroup(const Ogre::uint8& rqg);

    private:
      void _updateData(const Ogre::Real& alpha, const Ogre::Real& currentPos,
                       const Ogre::Real& parentTime);

      Ogre::Vector3 mOrigin;
      Ogre::Vector3 mDirection;
      Ogre::Real mLength;

      Ogre::Real mRealLength;
      Ogre::uint32 mDivisions;
      Ogre::uint32 mRecursivity;
      Ogre::Real mTime;
      Ogre::Real mTimeMultiplier;

      Ogre::Real mIntensity;

      Ogre::Real mWidthMultiplier;

      Ogre::Vector2 mBounds;
      Ogre::Vector2 mAngleRange;


      Ogre::Vector3 mTimeMultipliers;

      std::vector<Segment> mSegments;
      std::vector<Lightning*> mChildren;

      Ogre::BillboardSet* mBillboardSet;
      Ogre::SceneManager* mSceneManager;
      Ogre::SceneNode* mSceneNode;

      bool mCreated;
      bool mFinished;
  };
}}

#endif