include/vrfmsgs/ifCrtVrfObj.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2001 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: ifCrtVrfObj.h,v $ $Revision: 1.24 $ $State: Exp $
*******************************************************************************/


#ifndef DtIfCreateVrfObject_H_
#define DtIfCreateVrfObject_H_

#include <vrfExtProtocol/ifaceCont.h>
#include <vlutil/vlString.h>
#include <vrfExtProtocol/objType.h>
#include <vlpi/disEnums.h>
#include <vlutil/vlList.h>
#include <vlpi/appearance.h>
#include <vlpi/simulationAddress.h>
#include "vrfmsgs/vrfmsgsDefines.h"
#include "vrftasks/adminContent.h"
#include <vector>
#include <list>

class DT_DLL_vrfmsgs DtIfCreateVrfObject : public DtSimInterfaceContent
{
public:

   DtIfCreateVrfObject();

   virtual ~DtIfCreateVrfObject();

   DtIfCreateVrfObject(const DtIfCreateVrfObject& orig);

   DtIfCreateVrfObject& operator=(const DtIfCreateVrfObject& orig);

   virtual DtSimInterfaceContent * clone() const;

   virtual int type() const;

   virtual unsigned long requestId() const;
   virtual void setRequestId(unsigned long requestId);

   virtual void setVrfProcessAddress(const DtSimulationAddress & address);
   virtual const DtSimulationAddress & vrfProcessAddress() const;

   virtual void setObjectName(const DtString & objectName);
   virtual const DtString & objectName() const;

   virtual void setObjectType(const DtObjectType & objectType);
   virtual const DtObjectType & objectType() const;

   virtual void setForceType(const DtForceType forceType);
   virtual DtForceType forceType() const;

   virtual void setObjectLabel(const DtString & objectLabel);
   virtual const DtString & objectLabel() const;

   virtual const DtVector & position() const;
   virtual void setPosition(const DtVector & position);
   
   virtual DtReal heading() const;
   virtual void setHeading(DtReal heading);

   virtual const std::vector<DtVector>& vertexList() const;
   virtual const DtList& vertices() const;
   virtual void addVertex(const DtVector & vertex);

   virtual bool projection() const;
   virtual void setProjection(bool projection);

   virtual bool closedFigure() const;
   virtual void setClosedFigure(bool closedFigure);

   virtual const DtAppearance& appearance();
   virtual void setAppearance(const DtAppearance& appearance);

   virtual bool createSubObjects() const;
   virtual void setCreateSubObjects(bool createSubObjects);

   virtual bool addToOrganization() const;
   virtual void setAddToOrganization(bool addToOrg);

   virtual bool clampToGround() const;
   virtual void setClampToGround(bool clamp);


   virtual DtString initialFormation() const;
   virtual void setInitialFormation(const DtString& formation);

   virtual DtAggregateState initialAggregateState() const;
   virtual void setInitialAggregateState(DtAggregateState aggregateState);

   virtual std::list<DtAdminContent*>* initialAdminContent();
   virtual void setInitialAdminContent(std::list<DtAdminContent*> adminContent);
   virtual void addInitialAdminContent(DtAdminContent* adminContent);

   virtual std::list<DtSimInterfaceContent*>* initialInterfaceContent();
   virtual void setInitialInterfaceContent(std::list<DtSimInterfaceContent*> adminContent);
   virtual void addInitialInterfaceContent(DtSimInterfaceContent* adminContent);

   void setStartPosition(const DtVector& position);
   const DtVector& startPosition() const;
   void setEndPosition(const DtVector& position);
   const DtVector& endPosition() const;
   void setName(const DtString & name);
   const DtString & name() const;


   virtual void setUserData( const DtString& userData );
   virtual DtString userData() const;


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

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

protected:

   void copyList(const DtList & fromList);

   void emptyList();

protected:

   DtU32                myRequestId;
   DtSimulationAddress  myVrfProcessAddress;
   DtString             myObjectName;
   DtObjectType         myObjectType;
   DtForceType          myForceType;
   DtString             myObjectLabel;
   DtReal               myHeading;
   bool            myClosedFigure;
   bool            myProjection;
   std::vector<DtVector> myVertexList;
   mutable DtList  myVertices;
   DtAppearance    myAppearance;
   bool            myCreateSubObjects;
   bool            myAddToOrganization;
   bool            myClampToGround;
   DtString        myInitialFormation;
   DtU8           myInitialAggregateState;
   std::list<DtAdminContent*> myAdminContent;
   std::list<DtSimInterfaceContent*> myInterfaceContent;
   DtString       myUserData;
};

inline void DtIfCreateVrfObject::setStartPosition(const DtVector& position)
{
   setPosition(position);
}

inline const DtVector& DtIfCreateVrfObject::startPosition() const
{
   return position();
}

inline void DtIfCreateVrfObject::setEndPosition(const DtVector& position)
{
   addVertex(position);
}

inline const DtVector& DtIfCreateVrfObject::endPosition() const
{
   if (myVertices.count() > 0)
   {
      return *(DtVector*)myVertices.last()->data();
   }

   else
   {
      return DtVector::zero();
   }
}

inline void DtIfCreateVrfObject::setName(const DtString & name)
{
   setObjectName(name);
}

inline const DtString& DtIfCreateVrfObject::name() const
{
   return objectName();
}

#endif