StaticBillboardSet.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------------------
Copyright (c) 2006 John Judnich
 
This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
-------------------------------------------------------------------------------------*/
 
//StaticBillboardSet.h
//Provides a method of displaying billboards faster than Ogre's built-in BillboardSet
//functions by taking advantage of the static nature of tree billboards (note:
//StaticBillboardSet does not allow billboards to be moved or deleted individually in
//real-time)
//-------------------------------------------------------------------------------------
 
#ifndef __StaticBillboardSet_H__
#define __StaticBillboardSet_H__
 
#include <OgrePrerequisites.h>
#include <OgreRoot.h>
#include <OgreRenderSystem.h>
#include <OgreVector3.h>
#include <OgreMesh.h>
#include <OgreMaterial.h>
#include <OgreBillboard.h>
#include <OgreBillboardSet.h>
#include <OgreMaterialManager.h>
#include <OgreSceneNode.h>
#include <OgreStringConverter.h>
 
namespace Forests
{
 
   class SBMaterialRef;
   typedef std::map<Ogre::Material*, SBMaterialRef*> SBMaterialRefList;
 
   //--------------------------------------------------------------------------
   class StaticBillboardSet
   {
      //-----------------------------------------------------------------------------
      //Internal class - do not use
      class StaticBillboard
      {
      public:
         // Constructor
         StaticBillboard(const Ogre::Vector3 &pos, float xScale, float yScale,
            const Ogre::ColourValue &clr, Ogre::uint16 texcrdIndexU, Ogre::uint16 texcrdIndexV) :
         xPos((float)pos.x), yPos((float)pos.y), zPos((float)pos.z), xScaleHalf(0.5f * xScale), yScaleHalf(0.5f * yScale),
            texcoordIndexU(texcrdIndexU), texcoordIndexV(texcrdIndexV)
         {
            Ogre::Root::getSingletonPtr()->getRenderSystem()->convertColourValue(clr, &color);
         }
 
 
         // SVA mem friendly aligment
         float xPos, yPos, zPos;
         //float xScale, yScale;
         float xScaleHalf, yScaleHalf;
         Ogre::uint32 color;
         Ogre::uint16 texcoordIndexU, texcoordIndexV;
      };
 
   public:
      StaticBillboardSet(Ogre::SceneManager *mgr, Ogre::SceneNode *rootSceneNode);
      ~StaticBillboardSet();
 
      void createBillboard(const Ogre::Vector3 &position, float xScale = 1.0f, float yScale = 1.0f,
         const Ogre::ColourValue &color = Ogre::ColourValue::White, Ogre::uint16 texcoordIndexU = 0, Ogre::uint16 texcoordIndexV = 0)
      {
            mBillboardBuffer.push_back(new StaticBillboard(position, xScale, yScale, color, texcoordIndexU, texcoordIndexV));
      }
 
      void setBillboardOrigin(Ogre::BillboardOrigin origin);
 
      Ogre::BillboardOrigin getBillboardOrigin() const   { return mBBOrigin; }
 
      void setVisible(bool visible)
      {
         if (mVisible != visible)
         {
            mVisible = visible;
            mpSceneNode->setVisible(visible);
         }
      }
 
      void setFade(bool enabled, Ogre::Real visibleDist, Ogre::Real invisibleDist);
 
      void build();
 
      void clear();
 
      void setMaterial(const Ogre::String &materialName, const Ogre::String &resourceGroup =
         Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME);
 
      void setTextureStacksAndSlices(Ogre::uint16 stacks, Ogre::uint16 slices);
 
      static void updateAll(const Ogre::Vector3 &cameraDirection);
 
   private:
      Ogre::MaterialPtr getFadeMaterial(const Ogre::MaterialPtr &protoMaterial, Ogre::Real visibleDist, Ogre::Real invisibleDist);
 
   private:
 
      typedef std::vector < StaticBillboard* >  TBillBuf;
 
      bool                    mVisible;                  
      bool                    mFadeEnabled;              
 
      Ogre::SceneManager*     mpSceneMgr;                
      Ogre::SceneNode*        mpSceneNode;               
      Ogre::Entity*           mpEntity;                  
      Ogre::MeshPtr           mPtrMesh;                  
      Ogre::String            mEntityName;               
      Ogre::MaterialPtr       mPtrMaterial;              
      Ogre::MaterialPtr       mPtrFadeMaterial;          
      float                   mfUFactor, mfVFactor;      
 
      Ogre::BillboardOrigin   mBBOrigin;                 
      Ogre::Real              mFadeVisibleDist;          
      Ogre::Real              mFadeInvisibleDist;        
      TBillBuf                mBillboardBuffer;          
 
 
      // static data
   private:
 
      typedef std::map<Ogre::String, Ogre::MaterialPtr> FadedMaterialMap;
 
      static bool             s_isGLSL;                  
      //static bool             s_shadersGenerated;        ///< First instance generate shaders for billboard rendering
      static unsigned int     s_nSelfInstances;          
      static FadedMaterialMap s_mapFadedMaterial;        
 
      //static Ogre::uint32 selfInstances;
      static unsigned long GUID;
      static Ogre::String getUniqueID(const Ogre::String &prefix) { return prefix + Ogre::StringConverter::toString(++GUID); }
   };
 
 
 
   //-------------------------------------------------------------------------------------
 
   //SBMaterialRef::addMaterialRef() and ::removeMaterialRef() are used to keep track
   //of all the materials in use by the billboard system. This is necessary when keeping
   //the materials' vertex shaders up-to-date. To get the list of all materials in use,
   //use getList().
   class SBMaterialRef
   {
   public:
      static void addMaterialRef(const Ogre::MaterialPtr &matP, Ogre::BillboardOrigin o);
      static void removeMaterialRef(const Ogre::MaterialPtr &matP);
 
      inline static SBMaterialRefList &getList() { return selfList; }
 
      inline Ogre::Material *getMaterial() { return material; }
      inline Ogre::BillboardOrigin getOrigin() { return origin; }
 
   private:
      SBMaterialRef(Ogre::Material *mat, Ogre::BillboardOrigin o);
 
      static SBMaterialRefList selfList;
 
      Ogre::uint32 refCount;
      Ogre::Material *material;
      Ogre::BillboardOrigin origin;
   };
}
 
#endif