sEntityTrans.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2005 VT MAK
 *********************************************************************/
#pragma once

// Classes can not be forward declared because they are templated
#include <portal/pEntity.h>
#include <portal/pReflectedObjectManagerTypes.h>
#include <portal/pObjectPublisherTypes.h>

// Class Forwards
class DtExerciseConn;
class DtReflectedObject;
class DtReflectedEntityList;
class DtReflectedEntity;
class DtEntityPublisher;

namespace MAKVrExchange {
class DtPortalConnection;
}

// A helper class responsible for the translation of Entity State PDUs to
// Entity Data Exchange (portal) objects. This is not the same class (or even 
// close to) the same class in the HLA Broker. This simple class is provided
// to show the VR-Exchange API. It does not actually translate DIS entities
// in any useful way. 
class DtEntityTranslator
{

public:

   // Default CTOR, takes a reference to the disConn and the PortalConnection
   DtEntityTranslator(DtExerciseConn& disConn, MAKVrExchange::DtPortalConnection& portalConn);

   // Default DTOR
   virtual ~DtEntityTranslator();

   // Process any required updates
   virtual void tick();

   // Process discover messages from DIS
   virtual void discoverDisObject(const DtReflectedEntity &obj);
   // Process discover messages from the Portal
   virtual void discoverPortalObject(const MAKVrExchange::DtPortalReflectedEntity &obj);

   // Process updates from DIS
   virtual void receiveDisUpdate(const DtReflectedEntity &obj);
   // Process updates from the Portal
   virtual void receivePortalUpdate(const MAKVrExchange::DtPortalReflectedEntity &obj);

   // process removal messages from DIS
   virtual void processDisRemoval(const DtReflectedEntity &obj);
   // process removal messages from the Portal
   virtual void processProtalRemoval(const MAKVrExchange::DtPortalReflectedEntity &obj);

protected:
   // A function which is called to find out if this DIS object is fit to be 
   // discovered, and hence published.
   static bool disDiscoveryCriteria(DtReflectedObject* obj, void *usr);

   // A function which is called to find out if this Portal object is fit to be 
   // discovered, and hence published.
   static bool portalDiscoveryCriteria(
      const MAKVrExchange::DtPortalReflectedObject *obj, void *usr);

   static void disObjectAddedCb(DtReflectedEntity *obj, void *usrData);
   static void disObjectUpdatedCb(DtReflectedEntity *obj, void *usrData);
   static void disObjectDeletedCb(DtReflectedEntity *obj, void *usrData);

   static void portalObjectAddedCb(const MAKVrExchange::DtPortalReflectedEntity& obj, void *usrData);
   static void portalObjectUpdatedCb(const MAKVrExchange::DtPortalReflectedEntity& obj, void *usrData);
   static void portalObjectDeletedCb(const MAKVrExchange::DtPortalReflectedEntity& obj, void *usrData);

private:

   // A connection to the portal exercise connection and the DIS (VR-Link) 
   // exercise connection
   DtExerciseConn     &myDisConn;
   MAKVrExchange::DtPortalConnection &myPortalConn;

   // Pointers to reflected lists, or containers of reflected objects.
   DtReflectedEntityList *myDisReflectedList;
   MAKVrExchange::DtPortalReflectedEntityManager *myPortalReflectedManager;

   DtEntityPublisher *myDisEntityPublisher;
   MAKVrExchange::DtPortalEntityPublisher *myPortalEntityPublisher;


};