zone.h

Go to the documentation of this file.

/*
 * zone.h
 *
 * Copyright (C) 2007-2009  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.
 *
 *
 * Declaration of the basic Zone interfaces.  Anyone that wants to construct
 * aesop maps had better understand how these work.
 */

#ifndef AESOP_INTERFACE_ZONE_H__
#define AESOP_INTERFACE_ZONE_H__

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


namespace aesop {


// forward declarations
class LeafZone;




















class Zone {
public:
        // public typedefs -----------------------------------------------------
        enum eType {
                eType_Parent            = 0x01, 
                eType_Leaf              = 0x02, 
                eType_VirtualLeaf       = 0x12, 

                eType_Invalid           = 0x00  // keep this last
        };

        // virtual destructor --------------------------------------------------
        virtual ~Zone(void) throw();

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

        virtual const char * getId(void) const throw() = 0;

        virtual eType getType(void) const throw() = 0;

        virtual void getBoundingRect(OUT rect3d_t& r) const = 0;

        virtual bool containsPoint(IN const point3d_t& p) const throw() = 0;

        virtual LeafZone * getLeafZone(IN const point3d_t& p) throw() = 0;

        virtual const LeafZone * getLeafZone(IN const point3d_t& p) const throw() = 0;

        // allow getting and setting of user data (client data)
        virtual void * getUserPointer(void) const throw() = 0;
        virtual void setUserPointer(void *) throw() = 0;
};





typedef void (*leafzone_iteration_fn)(
                                IN LeafZone * lz,
                                IN void * context);








































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

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

        virtual void iterateVisibleZones(IN leafzone_iteration_fn callback,
                                IN void * context) = 0;

        virtual bool isLeafVisible(IN LeafZone * lzRemote) throw() = 0;

        virtual void iterateStaticInstances(IN instance_iteration_fn callback,
                                IN void * context) = 0;
};



};      // aesop namespace


#endif  // AESOP_INTERFACE_ZONE_H__