TreeLoader2D.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.
-------------------------------------------------------------------------------------*/
 
#ifndef __TreeLoader2D_H__
#define __TreeLoader2D_H__
 
#include "PagedGeometry.h"
#include "PropertyMaps.h"
 
#include <OgrePrerequisites.h>
 
 
namespace Forests {
 
class TreeLoader2D: public PageLoader
{
public:
    TreeLoader2D(PagedGeometry *geom, const TBounds &bounds);
    ~TreeLoader2D();
    
    void addTree(Ogre::Entity *entity, const Ogre::Vector3 &position, Ogre::Degree yaw = Ogre::Degree(0), Ogre::Real scale = 1.0f, void* userData = NULL);
 
    void deleteTrees(const Ogre::Vector3 &position, Ogre::Real radius = 0.001f, Ogre::Entity *type = NULL);
 
    void deleteTrees(TBounds area, Ogre::Entity *type = NULL);
 
    void setHeightFunction(Ogre::Real (*heightFunction)(Ogre::Real x, Ogre::Real z, void *userData), void *userData = NULL)
    {
        this->heightFunction = heightFunction;
        heightFunctionUserData = userData;
    }
 
    void setColorMap(const Ogre::String &mapFile, MapChannel channel = CHANNEL_COLOR);
 
    void setColorMap(Ogre::TexturePtr map, MapChannel channel = CHANNEL_COLOR);
 
    ColorMap *getColorMap() { return colorMap; }
 
    void setColorMapFilter(MapFilter filter)
    {
        colorMapFilter = filter;
        if (colorMap)
            colorMap->setFilter(colorMapFilter);
    }
 
    void setMaximumScale(Ogre::Real maxScale)   { maximumScale = maxScale;  }
 
   Ogre::Real getMaximumScale() const  { return maximumScale; }
 
    void setMinimumScale(Ogre::Real minScale)   { minimumScale = minScale;  }
 
    Ogre::Real getMinimumScale() const { return minimumScale; }
 
   const TBounds &getBounds() const { return actualBounds; }
 
    void loadPage(PageInfo &page);
 
private:
 
    struct TreeDef
    {
        Ogre::uint16 xPos, zPos;
        Ogre::uint8 scale, rotation;
    };
 
    //Information about the 2D grid of pages
    int pageGridX, pageGridZ;
    Ogre::Real pageSize;
    TBounds gridBounds, actualBounds;
 
    Ogre::Real maximumScale, minimumScale;
 
    //Colormap
    ColorMap *colorMap;
    MapFilter colorMapFilter;
 
    //Height data
    Ogre::Real (*heightFunction)(Ogre::Real x, Ogre::Real z, void *userData);   //Pointer to height function
    void *heightFunctionUserData;
 
    //Misc.
    PagedGeometry *geom;
 
    //A std::map of 2D grid arrays. Each array is the same size (pageGridX x pageGridZ), and
    //contains a std::vector list of trees. Each std::map entry corresponds to a single tree
    //type, and every tree defined in the std::map entry's grid should be of that tree type.
    std::map<Ogre::Entity*, std::vector<TreeDef>*> pageGridList;
    typedef std::map<Ogre::Entity*, std::vector<TreeDef>*>::iterator PageGridListIterator;
    typedef std::pair<Ogre::Entity*, std::vector<TreeDef>*> PageGridListValue;
    
    inline std::vector<TreeDef> &_getGridPage(std::vector<TreeDef> *grid, int x, int z)
    {
        #ifdef _DEBUG
        if(x >= pageGridX || z >= pageGridZ )
            OGRE_EXCEPT(Ogre::Exception::ERR_INVALIDPARAMS,
            "Grid dimension is out of bounds",
            "TreeLoader2D::_getGridPage()");
        #endif
 
        return grid[z * pageGridX + x];
    }
 
    inline void _setGridPage(std::vector<TreeDef> *grid, int x, int z, const std::vector<TreeDef> &page)
    {
        #ifdef _DEBUG
        if(x >= pageGridX || z >= pageGridZ )
            OGRE_EXCEPT(Ogre::Exception::ERR_INVALIDPARAMS,
            "Grid dimension is out of bounds",
            "TreeLoader2D::_getGridPage()");
        #endif
 
        grid[z * pageGridX + x] = page;
    }
};
 
 
 
} // namespace Forests
 
#endif