object-sync.h

Go to the documentation of this file.

/*
 * object-sync.h
 *
 * Copyright (C) 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.
 *
 *
 * The object sync libraries help keep local (client) physics in sync with what
 * is actually happening on the server.
 */

#ifndef AESOP_OBJECT_SYNC_H__
#define AESOP_OBJECT_SYNC_H__

// includes --------------------------------------------------------------------
#include "map-dynamics/map-dynamics.h"
#include "netrq/netrq.h"                // TODO: pull netrq functionality out?


namespace aesop {
class MapManager;
};



namespace aesop {










struct state_update_t {
        // constructor, manipulators
        state_update_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        position.clear();
                        orientation.clear();
                        linear.clear();
                        angular.clear();
                }
        void dump(IN const char * txt) const throw() {
                        DPRINTF("  State Update: %s", txt);
                        position.dump("    position");
                        orientation.dump("    orientation");
                        linear.dump("    linear velocity");
                        angular.dump("    angular velocity");
                }

        // data fields
        point3d_t               position;       
        quaternion_t            orientation;    
        point3d_t               linear;         
        point3d_t               angular;        
};



struct object_state_t : public state_update_t {
        // constructor, manipulators
        object_state_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        state_update_t::clear();
                        typeId.clear();
                        physicsObject = NULL;
                        dyn = 0;
                }
        void dump(IN const char * txt) const throw() {
                        DPRINTF("Object state: %s", txt);
                        state_update_t::dump(txt);
                        DPRINTF("  type: '%s'", (const char *) typeId);
                        if (!physicsObject) {
                                DPRINTF("  <no physics object>");
                        } else {
                                physicsObject->dump(txt);
                        }
                }

        // data fields
        AESOPIdBuffer           typeId;
        smart_ptr<MapDynamics>  dyn;
        smart_ptr<PhysicsObject> physicsObject;
};



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

        // aesop::ObjectSync class interface methods ---------------------------

        virtual void serverUpdate(IN dword_t id,
                                IN dword_t lastClientClock,
                                IN const state_update_t& state) = 0;

        virtual void clientUpdate(IN dword_t clientClock) = 0;

        virtual bool clientMoveRequest(IN dword_t id,
                                IN const point3d_t& delta,
                                IN float dt, 
                                OUT point3d_t& newPosition) = 0;

        virtual bool getState(IN dword_t id,
                                OUT object_state_t& state) = 0;

        virtual bool setTypeId(IN dword_t id,
                                IN const char * typeId) = 0;

        virtual bool setMapId(IN dword_t id,
                                IN const char * mapId) = 0;

        virtual void addRequests(IN netrq::Queue * queue,
                                IN dword_t clock) = 0;

        virtual void removeObject(IN dword_t id) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<ObjectSync> create(IN smart_ptr<MapManager> mapMgr);
};



};      // aesop namespace

#endif  // AESOP_OBJECT_SYNC_H__