psproxlist.h

Go to the documentation of this file.

/*
 * psproxlist.h
 *
 * Copyright (C) 2001 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License)
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 *
 */
#ifndef __PS_IMP_PROXIMITYLIST__
#define __PS_IMP_PROXIMITYLIST__

//=============================================================================
// Crystal Space Includes
//=============================================================================
#include <cstypes.h>
#include <iutil/comp.h>
#include <csutil/hash.h>
#include <csutil/scf.h>
#include <net/netbase.h>

//=============================================================================
// Project Includes
//=============================================================================
#include "util/psconst.h"

//=============================================================================
// Local Includes
//=============================================================================

class gemObject;
struct iObjectRegistry;
class EntityManager;

/* ProximityList must maintain following properties:
 *    - values in objectsThatWatchMe are unique
 *    - values in objectsThatIWatch  are unique
 *    - object X is in objectsThatWatchMe of object Y <===> object Y must be in objectsThatIWatch of X
 *    - objects with GetClientID()==0 have empty objectsThatIWatch
 *    - correspondence between objectsThatWatchMe and objectsThatWatchMe_touched
 *                             objectsThatIWatch  and objectsThatIWatch_touched
 */

class ProximityList
{
protected:
    gemObject* self;

    csArray<PublishDestination> objectsThatWatchMe;   
    csArray<gemObject*>  objectsThatIWatch;           
    csArray<csTicks> destRangeTimer;       

    csArray<bool> objectsThatWatchMe_touched;
    csArray<bool> objectsThatIWatch_touched;

    int          clientnum;
    bool         firstFrame;
    csVector3    oldPos;
    InstanceID  oldInstance;

    EntityManager* entityManager;

    void AddWatcher(gemObject* interestedobject, float range);

    void RemoveWatcher(gemObject* object);

    bool IsNear(iSector* sector,csVector3 &pos,gemObject* object,float radius);
    bool FindObject(gemObject* object);
    PublishDestination* FindObjectThatWatchesMe(gemObject* object, uint &x);
    bool FindObjectThatIWatch(gemObject* object);

    void TouchObjectThatWatchesMe(gemObject* object,float newrange);


    void UpdatePublishDestRange(PublishDestination* pd,
                                gemObject* myself,
                                gemObject* object,
                                uint objIdx,
                                float newrange);

public:
    ProximityList(iObjectRegistry* object_reg, gemObject* parent, EntityManager* entitymanager);
    ~ProximityList();

    bool Initialize(int cnum,gemObject* parent);

    bool StartWatching(gemObject* object, float range);

    void EndWatching(gemObject* object);

    bool StartMutualWatching(int othercnum, gemObject* otherObject,float range);

    bool EndMutualWatching(gemObject* fromobject);

    csArray<PublishDestination> &GetClients()
    {
        return objectsThatWatchMe;
    }
    int GetClientID()
    {
        return clientnum;
    }

    bool FindClient(uint32_t cnum);
    gemObject* FindObjectName(const char* name);

    bool CheckUpdateRequired();
    float RangeTo(gemObject* object, bool ignoreY = false, bool ignoreInstance = false);
    void DebugDumpContents(csString &out);

    void ClearTouched();
    bool GetUntouched_ObjectThatWatchesMe(gemObject* &object);
    bool GetUntouched_ObjectThatIWatch(gemObject* &object);
};

#endif