pCollisionInter.h

Go to the documentation of this file.

/******************************************************************************
 ** Copyright (c) 1992-2010 VT MAK
******************************************************************************/

#ifndef pCollisionInter_H_
#define pCollisionInter_H_


 
#include <portal/pBaseInteraction.h> //class DtPortalBaseInteraction

namespace MAKVrExchange {

class DtPortalConnection;


class DT_DLL_LIBPORTAL DtPortalCollisionInteraction : public DtPortalBaseInteraction
{
public:
   typedef void (*functionCallback_type) (const DtPortalCollisionInteraction &interaction, 
                                          void                               *userData);

   DtPortalCollisionInteraction();

   virtual ~DtPortalCollisionInteraction();



   DtDEC_ATTRIBUTE( DtString,  CollidingObjectIdentifier,   collidingObjectIdentifier );
   DtDEC_ATTRIBUTE( DtFloat64, IssuingObjectMass,           issuingObjectMass );
   DtDEC_ATTRIBUTE( DtVector,  IssuingObjectVelocityVector, issuingObjectVelocityVector );
   DtDEC_ATTRIBUTE( DtU32,     CollisionType,               collisionType );
   DtDEC_ATTRIBUTE( DtVector,  CollisionLocation,           collisionLocation );
   DtDEC_ATTRIBUTE( DtString,  EventIdentifier,             eventIdentifier );
   DtDEC_ATTRIBUTE( DtString,  IssuingObjectIdentifier,     issuingObjectIdentifier );

public:

   static const DtPortalMessageKind theKind;

   //Doxygen comments inherited from parent class
   virtual DtPortalMessageKind kind() const;

   //Doxygen comments inherited from parent class
   virtual const char *interactionKindName() const;

   //Doxygen comments inherited from parent class
   virtual unsigned int netSize() const;

   //Doxygen comments inherited from parent class
   virtual void writeSelfToBuffer( void *buffer ) const;

   //Doxygen comments inherited from parent class
   virtual void readSelfFromBuffer( const void *buffer );

   static void addCallback( DtPortalConnection    *connection, 
                            functionCallback_type  callbackFunction, 
                            void                  *userData );

   static void removeCallback( DtPortalConnection    *connection, 
                               functionCallback_type  callbackFunction, 
                               void                  *userData );

   static DtPortalMessage *create();

   //Doxygen comments inherited from parent class
   virtual std::ostream &printDataToStream( std::ostream &str ) const;

private:

   DtPortalCollisionInteraction &operator=( const DtPortalCollisionInteraction & );

   int operator==( const DtPortalCollisionInteraction & );

   int operator!=( const DtPortalCollisionInteraction & );

}; //end class DtPortalCollisionInteraction

inline DtPortalMessage *DtPortalCollisionInteraction::create()
{
   return new DtPortalCollisionInteraction();
}

inline const char *DtPortalCollisionInteraction::interactionKindName() const
{
   return "Collision";
}

inline DtPortalMessageKind DtPortalCollisionInteraction::kind() const
{
   return theKind;
}

}

#endif //end #ifndef pCollisionInter_H_