extEntityStateRepository.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2000 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: extEntSR.h,v $ $Revision: 1.13 $ $State: Exp $
*******************************************************************************/

#ifndef EXTENTSR_H
#define EXTENTSR_H

#include <vl/entityStateRepository.h>
#include <vrfExtObjects/vrfExtensions.h>

#include <list>

// class DtExtEntityStateRepository:
//
// Instances of DtExtEntityStateRepository are

#include <vrfExtObjects/vrfExtObjectsDefines.h>
class DT_DLL_vrfExtObjects DtExtEntityStateRepository : public DtEntityStateRepository, 
   public DtVrfExtensions
{

public:

   // default constructor
   DtExtEntityStateRepository();

   // destructor
   virtual ~DtExtEntityStateRepository();

   // copy constructor
   DtExtEntityStateRepository(const DtExtEntityStateRepository& orig);

   // assignment operator
   DtExtEntityStateRepository& operator=(const DtExtEntityStateRepository& orig);

   // Return a copy/empty object of the same type as this.
   virtual DtStateRepository* clone(bool copy = false) const;

   // Compares us against the supplied state repository and returns what's 
   // changed
   virtual int compare(const DtExtEntityStateRepository* rhs);

   // Returns what has changed since the last time we called compare
   virtual int compareToMostRecent();

   // Compares articulated parts in the local copy to current values
   // and returns a non-zero value if modified.  If modified, copies current
   // into last value
   virtual int compareArtParts(const std::list<int>&);

   // Compares each value that is valid, and, if any have changed, returns
   // DtChanged_Other
   virtual int compareArtParts(const DtArticulatedPart* source, const DtArticulatedPart* target);

   // Returns true if our stashed location is different than our
   // current location
   virtual bool locationsDifferent(bool updateIfDifferent);

public:
   bool needsVrfDataUpdate() const;
   void clearVrfDataNeedsUpdate();

   bool hasVrfObjectDataMessage() const;

   void setHasVrfObjectDataMessage(bool);

public:
   
   static DtExtEntityStateRepository* create();

protected:
   virtual void extensionModified();

public:
   // Override to set myHasVrfObjectDataMessage to true
   virtual bool setupFromVrfObjectData(const DtIfVrfObjectData& data);

protected:
   DtExtEntityStateRepository* myLastCopy;
   bool myVrfObjectDataUpdated;

   // If true, a vrf object data message has been seen for this object.  By default, this is false
   bool myHasVrfObjectDataMessage;
};

inline bool DtExtEntityStateRepository::hasVrfObjectDataMessage() const
{
   return myHasVrfObjectDataMessage;
}

inline void DtExtEntityStateRepository::setHasVrfObjectDataMessage(bool b)
{
   myHasVrfObjectDataMessage = b;
}

inline bool DtExtEntityStateRepository::needsVrfDataUpdate() const
{
   return myVrfObjectDataUpdated;
}

inline void DtExtEntityStateRepository::clearVrfDataNeedsUpdate()
{
   myVrfObjectDataUpdated = false;
}

inline void DtExtEntityStateRepository::extensionModified()
{
   myVrfObjectDataUpdated = true;
}

#endif