include/vrfutil/rwForceDescriptionList.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2007 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: rwForceDescriptionList.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/



#ifndef rwForceDescriptionList_h
#define rwForceDescriptionList_h

#include "vrfutil/rdrWritr.h"
#include "vrfutil/rwInt.h"
#include "vrfutil/rwIntegerList.h"
#include "vrfutil/rwVector.h"
#include "vrfutil/rwBoolean.h"
#include "vrfutil/rwString.h"
#include "vlutil/vlFilename.h"

#include <list>


#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtRwForceDescription : public DtReaderWriter
{
public:
   DtRwForceDescription();

   DtRwForceDescription(const DtString& name, DtReaderWriterRegistry* const parentRegistry = NULL);

   DtRwForceDescription(const DtSymbolString& name, DtReaderWriterRegistry* const parentRegistry = NULL);

   DtRwForceDescription(const DtRwForceDescription& orig, DtReaderWriterRegistry* const parentRegistry = NULL);

   DtRwForceDescription & operator=(const DtRwForceDescription & orig);


   virtual ~DtRwForceDescription();

   //get /set the force ID or DtForceType
   virtual void setForceId(int newId);
   virtual int forceId();
   
   //get /set the force name
   virtual void setForceName(DtString newName);
   virtual DtString forceName();

   //get /set the force color (0..255)
   virtual void setForceColor(int r, int g, int b);
   virtual DtVector forceColor();

   //get /set whether or not the force should be included in dialogs
   virtual void setIncludeInDialogs(bool include);
   virtual bool includeInDialogs();

   //sets which forces this force is hostile to
   virtual void setHostileToForce(int forceId);
   //gets a copy of the list of forces that this force is hostile to
   virtual std::list<int> hostileToList();

protected:
   DtRwInt myForceId;
   DtRwString myForceName;
   DtRwVector myForceColor;
   DtRwBoolean myIncludeInDialogs;
   DtRwIntegerList myHostileToList;
};


class DT_DLL_vrfutil DtRwForceDescriptionList : public DtRwList
{
public:
   DtRwForceDescriptionList();

   DtRwForceDescriptionList(const DtString& name, DtReaderWriterRegistry* const 
      parentRegistry = NULL);
   DtRwForceDescriptionList(const DtSymbolString& name, DtReaderWriterRegistry* const 
      parentRegistry = NULL);

   virtual ~DtRwForceDescriptionList();

   DtRwForceDescriptionList(const DtString& name, const DtRwForceDescriptionList& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwForceDescriptionList(const DtSymbolString& name, const DtRwForceDescriptionList& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwForceDescriptionList& operator=(const DtRwForceDescriptionList& orig);

   virtual void addForce(DtRwForceDescription* rwForce);

   virtual void removeForce(DtRwForceDescription* rwForce, DtListItem* listItem);

   void emptyList();

protected:

   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   void copyList(const DtRwForceDescriptionList& orig);
};

#endif