pBoomInter.h

Go to the documentation of this file.

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

#include <portal/pInteraction.h>
#include <vlutil/vlString.h>
#include <vlutil/vlNetTypes.h>
#include <matrix/vlVector.h>


namespace MAKVrExchange {
class DtPortalConnection;
}

// \brief Represents a weapon fire event.
//
// DtPortalBoomInteraction represents a noise that sounds like "Boom". This example is 
// very simple and silly, but is intended to show users to how to create portal Interaction 
// messages.
class DtPortalBoomInteraction : public MAKVrExchange::DtPortalInteraction
{
public:

   typedef void (*DtPortalBoomInteractionCb)
      (const DtPortalBoomInteraction &inter, void *usr);

public:

   // The default CTOR
   DtPortalBoomInteraction();

   // The default DTOR
   virtual ~DtPortalBoomInteraction();

   // The Volume of the Boom. Valid range is 0->10 with 10 being very loud. 
   DtDEC_ATTRIBUTE(DtU32, Volume, volume);

   // Answers the question, did the ground move? 
   DtDEC_ATTRIBUTE(bool, GroundMovement, groundMovement);

public:

   virtual MAKVrExchange::DtPortalMessageKind kind() const;
   virtual const char * interactionKindName() const { return "Boom"; }

   virtual unsigned int netSize() const;
   virtual void writeSelfToBuffer(void *buffer) const ;
   virtual void readSelfFromBuffer(const void *buffer);
   virtual std::ostream &printDataToStream(std::ostream &str) const;


public:

   static const MAKVrExchange::DtPortalMessageKind theKind;

   static DtPortalMessage *create();

   static void addCallback(MAKVrExchange::DtPortalConnection *conn, 
      DtPortalBoomInteractionCb cb, void *usr);
   static void removeCallback(MAKVrExchange::DtPortalConnection *conn, 
      DtPortalBoomInteractionCb cb, void *usr);

};