vrfOverlayObjectStateRepository.h

Go to the documentation of this file.

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

#pragma once



#include "vrfobjcore/vrfObjectStateRepository.h"
#include <vrfutil/rwUUID.h>

#include "vrfobjcore/vrfobjcoreDefines.h"

class DtRwIntelCollectionArea;

class DT_DLL_vrfobjcore DtVrfOverlayObjectStateRepository : public DtVrfObjectStateRepository
{
  protected:
    DtVrfOverlayObjectStateRepository();

  public:

    DtVrfOverlayObjectStateRepository (DtVrfObject* vrfObject,
                                      const DtObjectType& objectType,
                                      DtVrfObjectParameters* parameters,
                                      const DtString& rwName = DtString::nullString(),
                                      DtReaderWriterRegistry* parentRegistry = 0);

    DtVrfOverlayObjectStateRepository
        (const DtVrfOverlayObjectStateRepository& orig,
         const DtString& rwName = DtString::nullString(),
         DtReaderWriterRegistry* parentRegistry = 0);

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

    virtual ~DtVrfOverlayObjectStateRepository();

    static DtVrfObjectStateRepository * creator (const DtString& name,
                                                 DtVrfObject* vrfObject,
                                                 const DtObjectType& objectType,
                                                 DtVrfObjectParameters * parameters,
                                                 DtReaderWriterRegistry * parentRegistry);

    static DtVrfOverlayObjectStateRepository* 
       isVrfOverlayObjectStateRepository(DtSimObjectStateRepository* repository);

    static const DtVrfOverlayObjectStateRepository* 
       isVrfOverlayObjectStateRepository(const DtSimObjectStateRepository* repository);

    virtual double sensorSignature(const DtSymbolString& sensorDomain) const;

    virtual void setSensorSignature(const DtSymbolString& domain, double);

    virtual void removeSensorSignature(const DtSymbolString&);

    virtual const std::map<DtSymbolString, double>& sensorSignatures() const;

    virtual DtSimObjectStateRepository* clone
        (const DtString& rwName = DtString::nullString(),
         DtReaderWriterRegistry* parentRegistry = 0) const;

    virtual DtString type() const;

    virtual const int vrfObjectStateRepositorySubType() const;

    virtual bool activated() const;
    virtual void setActivated(bool);

    virtual bool useActivationTimes() const;
    virtual void setUseActivationTimes(bool);

    virtual bool activationTimesAreSimulationTime() const;
    virtual void setActivationTimesAreSimulationTime(bool);

    virtual void setActivationTime(double);
    virtual double activationTime() const;

    virtual void setDeactivationTime(double);
    virtual double deactivationTime() const;


   virtual void updateBasedOnActivationState();

   virtual bool shouldActivate();

   virtual bool shouldDeactivate();

    virtual void attachToParent(DtSimObjectStateRepository* parent);
    virtual void attachToParent(const DtUUID& parent);
    virtual void detachFromParent();

    virtual void setAttachedTickRateForPublication(double);
    virtual double attachedTickRateForPublication() const;

    virtual int color() const;
    virtual void setColor (int color);
    virtual void setColor(DtU8 red, DtU8 green, DtU8 blue, DtU8 alpha);

    virtual const DtString & parentName() const;
    virtual void setParentName(const DtString & parentName);

   virtual void setUserData(const char* data, int dataLen);
   virtual const DtString& userData() const;

   virtual double ceiling() const;
   virtual void setCeiling(double);
   virtual void setPhysicalLineHeight(double);
   virtual double physicalLineHeight() const;
   virtual bool ceilingSet() const;

   virtual double floor() const;
   virtual void setFloor(double);

   virtual double physicalLineWidth() const;
   virtual void setPhysicalLineWidth(double);

   virtual double intelAreaModifierForForce(int force) const;

   //Reimplements DtVrfObjectStateRepository::onTerrainSurface.
   //Returns indeterminate.
   virtual boost::tribool onTerrainSurface() const;

   virtual void setExtendedDataMap(const ExtendedData&);
   virtual void setExtendedDataMap(const std::map<std::string, std::string>& e);
   virtual void setExtendedData(const DtString& key, const DtString& value);
   virtual void updateCollectionAreaInformation();
   virtual void updatePhysicalLineWidthInformation();
   virtual void updatePhysicalLineHeightInformation();
   virtual void updateCeilingInformation();
   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
                                         const DtVariableBindingsList& variableBindings);

   virtual bool inside(const DtVector& point) const;

protected:
   DtRwInt     myColor;
   DtRwString  myParentName;
   DtRwReal    myPhysicalLineHeight;
   DtRwReal    myPhysicalLineWidth;

   DtRwString  myUserData;

   std::map<DtSymbolString, double> mySensorSignatures;

   DtRwIntelCollectionArea* myIntelCollectionAreaInformation;

   double myAttachedTickRateForPublication;
};