map-kdtree.h

Go to the documentation of this file.

/*
 * map-kdtree.h
 *
 * Copyright (C) 2010  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef AESOP_MAP_KDTREE_H__
#define AESOP_MAP_KDTREE_H__


// includes --------------------------------------------------------------------
#include "glut/renderable.h"
#include "map-dynamics/map-dynamics.h"
#include "kdtree/kdtree.h"


namespace aesop {



struct map_draw_stats_t {
        // constructor, manipulators
        map_draw_stats_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        nObjects = 0;
                }

        // data fields
        int             nObjects;       
};



struct kd_node_t {
        rect3d_t        rect;
        int             depth;  
};


typedef void (*kdtree_callback_fn)(IN const kd_node_t& node,
                                IN void * context);

typedef void (*kdtree_object_fn)(IN glut::Renderable * model,
                                IN const glut::render_context_t& rc,
                                IN glut::RenderQueue * rq,
                                IN void * context);


class MapKdTree {
public:
        // virtual destructor --------------------------------------------------
        virtual ~MapKdTree(void) throw();

        // aesop::MapKdTree class interface methods ----------------------------

        virtual MapDynamics * getMapDynamics(void) throw() = 0;

        virtual void walkNodes(IN kdtree_callback_fn callback,
                                IN void * context) = 0;

        virtual void walkFrontToBack(IN const glut::render_context_t& rc,
                                        IN glut::RenderQueue * rq,
                                        IN kdtree_object_fn callback,
                                        IN void * context) = 0;

        // public static methods (factory methods) -----------------------------
        static smart_ptr<MapKdTree> create(IN smart_ptr<MapDynamics>& map);
};



void drawMap(IN MapKdTree * mapKdTree,
                        IN const glut::render_context_t& rc,
                        IN glut::RenderQueue * rq,
                        OUT map_draw_stats_t& stats);



};      // aesop namespace

#endif  // AESOP_MAP_KDTREE_H__