ifEmbarkationInformation.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2015 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include <vrfExtProtocol/simInterfaceContent.h>
#include <vlutil/vlNetTypes.h>
#include <vlpi/netStructs.h>
#include "vrfmsgs/ifServerRequestResponse.h"
#include <vrfutil/rwUUID.h>

#include <vector>


const int DtEmbarkCannotEmbark = 0;
const int DtEmbarkSlotAvailable = 1;
const int DtEmbarkCanDisembark = 2;
const int DtEmbarkCannotDisembark = 3;
const int DtEmbarkImmediatelyDisembark = 4;

const int DtEmbarkNoSlotAvailableForEntity = 4;

#include "vrfmsgs/vrfmsgsDefines.h"
class DT_DLL_vrfmsgs DtIfEmbarkationInformation : public DtIfServerRequestResponse
{

public:
   DtIfEmbarkationInformation();

   DtIfEmbarkationInformation(
      const DtIfEmbarkationInformation & orig);

   const DtIfEmbarkationInformation & operator=(
      const DtIfEmbarkationInformation & orig);

   virtual ~DtIfEmbarkationInformation();

   virtual int type() const;

   virtual DtSimInterfaceContent * clone() const;

   virtual void setEmbarkObject(const DtUUID&);
   virtual const DtUUID& embarkObject() const;

   virtual void setParent(const DtUUID&);
   virtual const DtUUID& parent() const;

   virtual void setResult(int);
   virtual int result() const;

   virtual void setSlot(int);
   virtual int slot() const;

   virtual void setSlotName(const DtString&);
   virtual const DtString& slotName() const;

   virtual void setSlotType(const DtString&);
   virtual const DtString& slotType() const;

   virtual void setEmbarkedAppearance(int);
   virtual int embarkedAppearance() const;

   virtual void setEmbarkedAnimation(const DtString&);
   virtual const DtString& embarkedAnimation() const;

   virtual void setJumpToLocation(bool);
   virtual bool jumpToLocation() const;

   virtual void setInvisibleWhenEmbarked(bool);
   virtual bool invisibleWhenEmbarked() const;

   virtual void setTurnToHeading(bool);
   virtual bool turnToHeading() const;

   virtual void setOrientOnIngress(bool);
   virtual bool orientOnIngress() const;
   
   virtual void setEmbarkedOrientation(const DtTaitBryan&);
   virtual const DtTaitBryan& embarkedOrientation() const;

   virtual void setEmbarkedPosition(const DtVector&);
   virtual const DtVector& embarkedPosition() const;

   virtual void setLoadPath(const std::vector<DtVector>&);
   virtual void addLoadPathPoint(const DtVector&);
   virtual const std::vector<DtVector>& loadPath() const;

   virtual int netRepSize() const;

   virtual bool setFromNet(const char* contentBuffer, unsigned contentSize);

   virtual bool setToNet();

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

   virtual void setTechnique(const DtString&);
   virtual const DtString& technique() const;

   virtual void setPublishLoadPoints(bool);
   virtual bool publishLoadPoints() const;

protected:
   DtUUID                myEmbarkObject;
   DtUUID                myParent;
   int                   myResult;
   int                     mySlot;
   int                     myEmbarkedAppearance;
   DtString                myEmbarkedAnimation;
   DtString                myTechnique;
   DtString                mySlotName;
   DtString                mySlotType;
   DtTaitBryan             myEmbarkedOrientation;
   DtVector                myEmbarkedPosition;
   std::vector<DtVector>   myLoadPath;
   bool                    myPublishLoadPoints;
   bool                    myJumpToLocation;
   bool                    myTurnToHeading;
   bool                    myOrientOnIngress;
   bool                 myInvisibleWhenEmbarked;
};