map-dynamics.h

Go to the documentation of this file.

/*
 * map-dynamics.h
 *
 * Copyright (C) 2008,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.
 *
 */

#ifndef AESOP_MAP_DYNAMICS_H__
#define AESOP_MAP_DYNAMICS_H__


// includes --------------------------------------------------------------------
#include "aesop-map/map.h"
#include "aesop-physics/aesop-physics.h"


// forward decl
class Datahash;


namespace aesop {


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup aesop_map_mgmt
/// \defgroup map_dynamics Map Dynamics Library
///
/// These objects know how to dynamically manipulate (tick) loaded maps.
/// This library is what binds the \ref aesop_physics library with Maps.
///
/// Map objects themselves don't understand physics or dynamics, they just
/// provide raw data about object placement and space (zone) partitioning.
///
/// The purpose of this library is to allow people to implement their own
/// Map / Zone objects as necessary (different space partitioning schemes,
/// different map formats, etc.) but be able to re-use all of the handling for
/// dynamic objects.  The goal is that people can override map/zone objects
/// without worrying about dynamics at all.
///
/// <b>This library must know nothing about rendering.</b>  MapDynamics
/// objects are used on both the server (as the authoritative state) and on the
/// client (in a predictive, non-authoritative way to accommodate network lag).
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// zone iteration callback
typedef void (*zone_obj_iteration_fn)(
                                IN smart_ptr<Instance>& instance,
                                IN smart_ptr<PhysicsObject>& obj,
                                IN void * context);


/// this is a base class for caller-specified context attached to PhysicsObjects
class ObjectContext {
public:
        // virtual destructor --------------------------------------------------
        virtual ~ObjectContext(void) throw();
};



/// create one of these to handle dynamics (physics etc.) for a given Map
class MapDynamics {
public:
        // virtual destructor --------------------------------------------------
        virtual ~MapDynamics(void) throw();

        // aesop::MapDynamics class interface methods -------------------------
        virtual smart_ptr<Map> getMap(void) = 0;
        virtual smart_ptr<PhysicsWorld> getPhysics(void) = 0;
        virtual smart_ptr<PhysicsObject> addInstance(
                                IN smart_ptr<Instance>& instance) = 0;
        virtual void removeObject(IN smart_ptr<PhysicsObject>& obj) = 0;
        virtual void tickMap(IN float seconds) = 0;

        /// iterates over all instances within the given zone (static and
        ///   dynamic objects).
        virtual void iterateInstancesInZone(IN Zone * zone,
                                IN zone_obj_iteration_fn fn,
                                IN void * context) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<MapDynamics> create(IN smart_ptr<Map>& map,
                                IN const Datahash * params);
};



/// can return null!
smart_ptr<Instance> getInstanceFromPhysicsObject(IN smart_ptr<PhysicsObject>& obj);


/// can return null!
MapDynamics * getMapDynamicsFromPhysicsObject(IN smart_ptr<PhysicsObject>& obj);


};      // aesop namespace

#endif  // AESOP_MAP_DYNAMICS_H__