zone.cpp

Go to the documentation of this file.

/*
 * zone.cpp
 * 
 * Copyright (C) 2008  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.
 *
 *
 * Simple zone implementation.  See mapzone.h and aesop-map/zone.h
 */

// includes --------------------------------------------------------------------
#include "mapzone.h"

#include "common/wave_ex.h"
#include "typeinst/typeinst.h"
#include "geometry/geometry_3d.h"
#include "perf/perf.h"
#include "util/token_stream.h"


namespace mapzone {



//
//      private helper methods
//

class ZoneImpl : public aesop::LeafZone {
public:
        // constructor, destructor ---------------------------------------------
        ZoneImpl(void) throw();
        ~ZoneImpl(void) throw() { }

        // public class methods ------------------------------------------------
        void initialize(IN std::istream& stream,
                                IN eType type);
        void resolveIds(IN zone_map_t& map);
        void calcBoundaries(void);
        static ZoneImpl * getZoneImpl(IN aesop::Zone * z);

        // aesop::Zone class interface methods ---------------------------------
        const char * getId(void) const throw() { return m_id.c_str(); }
        aesop::Zone::eType getType(void) const throw() { return m_type; }
        void getBoundingRect(OUT rect3d_t& r) const { r = m_bounds; }
        bool containsPoint(IN const point3d_t& p) const throw();
        aesop::LeafZone * getLeafZone(IN const point3d_t& p) throw();
        const aesop::LeafZone * getLeafZone(IN const point3d_t& p) const throw();
        void * getUserPointer(void) const throw() { return m_user; }
        void setUserPointer(void * p) throw() { m_user = p; }

        // aesop::LeafZone class interface methods -----------------------------
        void iterateVisibleZones(IN aesop::leafzone_iteration_fn callback,
                                IN void * context);
        bool isLeafVisible(IN LeafZone * lz) throw();
        void iterateStaticInstances(IN aesop::instance_iteration_fn callback,
                                IN void * context);

private:
        // private typedefs ----------------------------------------------------

        // these are weak references (do NOT delete!).  Containing map owns the
        // life cycle of zones.
        typedef std::set<ZoneImpl * > zone_set_t;

        // private helper methods ----------------------------------------------
        void loadParentZone(IN std::istream& stream);
        void loadLeafZone(IN std::istream& stream);
        void loadVirtualLeafZone(IN std::istream& stream);

        // private data members ------------------------------------------------
        std::string             m_id;           // ID of this zone
        eType                   m_type;         // what type of zone?
        rect3d_t                m_bounds;       // bounding rect
        VecString               m_zoneIds;      // used for loading only!
        aesop::vec_instance_t   m_static;       // static instances
        zone_set_t              m_zones;        // related zones
        void *                  m_user;         // user pointer
        bool                    m_haveBounds;   // calculated bounds?
};



ZoneImpl::ZoneImpl
(
void
)
throw()
{
        m_user = NULL;
}



//
//      ZoneImpl -- public class methods
//

void
ZoneImpl::initialize
(
IN std::istream& stream,
IN eType type
)
{
        perf::Timer timer("mapzone::Zone::initialize");
        ASSERT(stream.good(), "bad?");
        ASSERT(!m_zones.size(), "Already have zones?");
        ASSERT(!m_zoneIds.size(), "Already have zone IDs?");

        m_haveBounds = false;

        // save zone type
        ASSERT(eType_Leaf == type || eType_Parent == type
               || eType_VirtualLeaf == type,
            "Bad zone type: %d", type);
        m_type = type;

        // start
        expectToken(stream, "{");

        // zone metadata
        expectToken(stream, "id");
        getNextToken(stream, m_id);
//      DPRINTF("Loading zone with id='%s'", m_id.c_str());

        // switch based on type
        if (eType_Leaf == this->getType()) {
                this->loadLeafZone(stream);
        } else if (eType_Parent == this->getType()) {
                this->loadParentZone(stream);
        } else if (eType_VirtualLeaf == this->getType()) {
                this->loadVirtualLeafZone(stream);
        } else {
                ASSERT(false, "should never get here (invalid zone type)");
        }

        // all done
//      m_bounds.dump("  Final bounds");
}



void
ZoneImpl::resolveIds
(
IN zone_map_t& map
)
{
        // loop through all our IDs, and resolve to zone objects
        ASSERT(!m_zones.size(), "Already have zones?");
        for (VecString::const_iterator i = m_zoneIds.begin();
             i != m_zoneIds.end(); ++i) {
                const char * id = i->c_str();

                zone_map_t::iterator j = map.find(id);
                if (map.end() == j) {
                        const char * selfId = this->getId();
                        WAVE_EX(wex);
                        wex << "Zone id not found: '" << id << "'.  Used by ";
                        wex << "zone '" << selfId << "'";
                }

                Zone * z = j->second;
                ASSERT(z, "null zone in map?");

                ZoneImpl * zi = ZoneImpl::getZoneImpl(z);
                ASSERT(zi, "null");

                // okay, this ID is resolved!
                m_zones.insert(zi);
        }

        // everything is resolved, release IDs
        m_zoneIds.clear();
}



void
ZoneImpl::calcBoundaries
(
void
)
{
        if (m_haveBounds)
                return;         // already calculated (or known)

        ASSERT(eType_Parent == this->getType(),
            "Only parent zones should need to calculate boundaries");

        // loop through all children, and have them recalculate
        bool first = true;
        for (zone_set_t::iterator i = m_zones.begin(); i != m_zones.end();
             ++i) {
                ZoneImpl * zi = *i;
                ASSERT(zi, "null zone in m_zones");

                // don't accumulate this child if it is virtual
                if (eType_VirtualLeaf == zi->getType()) {
                        continue;       // skip virtuals
                }

                zi->calcBoundaries();

                if (first) {
                        // first child!  Copy bounds
                        zi->getBoundingRect(m_bounds);
                        first = false;
                } else {
                        // later child.  Expand bounds to include
                        rect3d_t r;
                        zi->getBoundingRect(r);
                        m_bounds.expand(r);
                }
        }

        // should have at least one child!
        ASSERT_THROW(!first, "Parent zone '" << this->getId() <<
            "' has no non-virtual children?");

        // okay, have bounds!
        m_haveBounds = true;
}



ZoneImpl *
ZoneImpl::getZoneImpl
(
IN aesop::Zone * z
)
{
        ASSERT(z, "null");

        ZoneImpl * zi = dynamic_cast<ZoneImpl *>(z);
        if (!zi) {
                WAVE_EX(wex);
                wex << "Zone object is not implemented by mapzone library";
        }
        return zi;
}



//
//      ZoneImpl -- aesop::Zone class interface methods
//

bool
ZoneImpl::containsPoint
(
IN const point3d_t& p
)
const
throw()
{
        return m_bounds.containsPoint(p);
}



aesop::LeafZone *
ZoneImpl::getLeafZone
(
IN const point3d_t& p
)
throw()
{
        const Zone * cz = (const Zone *) this;
        const LeafZone * clz = cz->getLeafZone(p);
        return (LeafZone *)(clz);
}



const aesop::LeafZone *
ZoneImpl::getLeafZone
(
IN const point3d_t& p
)
const
throw()
{
        if (eType_VirtualLeaf == this->getType()) {
                return NULL;
        } else if (eType_Leaf == this->getType()) {
                if (this->containsPoint(p)) {
                        return this;
                }
        } else {
                // this isn't a leaf zone!
                // In that case, m_zones is the list of our children
                for (zone_set_t::const_iterator i = m_zones.begin();
                     i != m_zones.end(); ++i) {
                        const ZoneImpl * zi = *i;
                        ASSERT(zi, "empty in child array");

                        const LeafZone * lz = zi->getLeafZone(p);
                        if (lz) {
                                return lz;
                        }
                }
        }

        // no leaf zone found that contained the specified point!
        return NULL;
}



//
//      ZoneImpl -- aesop::LeafZone class interface methods
//

void
ZoneImpl::iterateVisibleZones
(
IN aesop::leafzone_iteration_fn callback,
IN void * context
)
{
        ASSERT(callback, "null");
        // ASSERT(context) -- we don't care!

        // first, call with ourselves!
        callback(this, context);

        // we are a leaf zone, so m_zones is the list of visible zones
        for (zone_set_t::iterator i = m_zones.begin(); i != m_zones.end();
             ++i) {
                ZoneImpl * zi = *i;
                ASSERT(zi, "null zone in vector");

                // call back with this leaf zone
                callback(zi, context);
        }
}



bool
ZoneImpl::isLeafVisible
(
IN LeafZone * lz
)
throw()
{
        ASSERT(lz, "null");

        ZoneImpl * zi = dynamic_cast<ZoneImpl *>(lz);
        ASSERT(zi, "can't downcast from leaf zone?");

        // special case: ourselves
        if (zi == this)
                return true;

        // check against set
        return (m_zones.end() != m_zones.find(zi));
}



void
ZoneImpl::iterateStaticInstances
(
IN aesop::instance_iteration_fn callback,
IN void * context
)
{
        ASSERT(callback, "null");
        // ASSERT(context) -- we don't care!

        // iterate over all static instances
        for (aesop::vec_instance_t::iterator i = m_static.begin();
             i != m_static.end(); ++i) {

                // call callback
                callback(*i, context);
        }
}



//
//      ZoneImpl -- private helper methods
//

void
ZoneImpl::loadParentZone
(
IN std::istream& stream
)
{
        ASSERT(stream.good(), "bad?");

        // keep reading child nodes
        std::string token;
        while (true) {
                getNextToken(stream, token);

                if ("}" == token) {
                        break;  // no more child zones
                }

                if ("child" != token) {
                        WAVE_EX(wex);
                        wex << "parent zone should contain only 'child' ";
                        wex << "entries.  Found this instead: " << token;
                }

                getNextToken(stream, token);
                 DPRINTF("  Parent zone '%s' has child zone '%s'",
                    m_id.c_str(), token.c_str());

                // don't resolve the ID yet (second pass).  Just store for now
                m_zoneIds.push_back(token);
        }
}



void
ZoneImpl::loadLeafZone
(
IN std::istream& stream
)
{
        ASSERT(stream.good(), "bad?");

        // bounding rect
        expectToken(stream, "boundary");
        parseRect3d(stream, m_bounds);
        m_bounds.dump("bounding rect");
        if (!m_bounds.isValid()) {
                WAVE_EX(wex);
                wex << "Leaf zone '" << m_id << "' has invalid bounding rect.";
        }
        m_haveBounds = true;            // okay, leaf has bounds

        // other leaf nodes visible from here
        expectToken(stream, "visible");
        expectToken(stream, "{");
        while (true) {
                std::string token;
                getNextToken(stream, token);

                if ("}" == token) {
                        break;          // no more possibly visible nodes
                }
                if ("zone" != token) {
                        WAVE_EX(wex);
                        wex << "visible list should contain only 'zone' ";
                        wex << "entries.  Found this instead:" << token;
                }

                getNextToken(stream, token);
                DPRINTF("  Leaf zone '%s' is visible from '%s'",
                    token.c_str(), m_id.c_str());
                m_zoneIds.push_back(token);
        }

        // all static type instances in this leaf
        expectToken(stream, "staticInstances");
        expectToken(stream, "{");
        loadInstances(stream, m_static);

        // all done!
        expectToken(stream, "}");       // end of leaf zone
}



void
ZoneImpl::loadVirtualLeafZone
(
IN std::istream& stream
)
{
        ASSERT(stream.good(), "bad?");

        // bounding rect
        expectToken(stream, "boundary");
        parseRect3d(stream, m_bounds);
        m_bounds.dump("bounding rect");
        if (!m_bounds.isValid()) {
                WAVE_EX(wex);
                wex << "Virtual leaf zone '" << m_id << "' has invalid bounding rect.";
        }
        m_haveBounds = true;            // okay, leaf has bounds

        // virtual leaf zone: static instances only!
        expectToken(stream, "staticInstances");
        expectToken(stream, "{");
        loadInstances(stream, m_static);

        // all done!
        expectToken(stream, "}");       // end of leaf zone
}



//
//      public API
//

smart_ptr<aesop::Zone>
loadZone
(
IN std::istream& stream,
IN aesop::Zone::eType type
)
{
        ASSERT(stream.good(), "not good?");
        ASSERT(aesop::Zone::eType_Invalid != type, "Bad type: %d", type);
        smart_ptr<ZoneImpl> local = new ZoneImpl;
        ASSERT(local, "out of memory");

        local->initialize(stream, type);

        return local;
}



void
resolveZoneIds
(
IN aesop::Zone * zone,
IN zone_map_t& map
)
{
        ASSERT(zone, "null");

        ZoneImpl * zi = ZoneImpl::getZoneImpl(zone);
        ASSERT(zi, "null");
        zi->resolveIds(map);
}



void
calcBoundaries
(
IN aesop::Zone * zone
)
{
        ASSERT(zone, "null");

        ZoneImpl * zi = ZoneImpl::getZoneImpl(zone);
        ASSERT(zi, "null");
        zi->calcBoundaries();
}



};      // mapzone namespace