tdlContactMessageGeneratorControllerDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/vrfobjparamDefines.h"
#include "vrfobjparam/tdlMessageGeneratorControllerDescriptor.h"
#include <readerWriter/rwString.h>
#include "vrfutil/rwStringList.h"

class DT_DLL_vrfobjparam DtTDLContactMessageGeneratorControllerDescriptor : public DtTDLMessageGeneratorControllerDescriptor
{
public:
   DtTDLContactMessageGeneratorControllerDescriptor(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtTDLContactMessageGeneratorControllerDescriptor(
      const DtTDLContactMessageGeneratorControllerDescriptor& orig,
      DtReaderWriterRegistry*  parentRegistry = 0);

   DtTDLContactMessageGeneratorControllerDescriptor& operator=(
      const DtTDLContactMessageGeneratorControllerDescriptor& orig);

   virtual ~DtTDLContactMessageGeneratorControllerDescriptor();

   virtual DtComponentDescriptor* clone(
      DtReaderWriterRegistry*  parentRegistry = 0) const;

   virtual DtString type() const;

   static DtComponentDescriptor* creator();

   virtual double sendContactReportsOnOverlayLayersWithin() const;
   virtual void setSendContactReportsOnOverlayLayersWithin(double);

   virtual double expirationTime() const;
   virtual void setExpirationTime(double);

   virtual bool reportOnOwnForce() const;
   virtual void setReportOnOwnForce(bool newVal);


   virtual bool reportOnHostileForces() const;
   virtual void setReportOnHostileForces(bool newVal);


   virtual bool reportOnNeutralForces() const;
   virtual void setReportOnNeutralForces(bool newVal);


   virtual bool reportOnSensorContacts() const;
   virtual void setReportOnSensorContact(bool newVal);

   virtual DtRwStringList& sendContactReportsForObjectsOnOverlayLayers();
   virtual const DtRwStringList& sendContactReportsForObjectsOnOverlayLayers() const;
   virtual void setSendContactReportsForObjectsOnOverlayLayers(const DtRwStringList& list);
   virtual bool sendContactReportsForObjectsOnOverlayLayer(const DtString& t) const;

protected:

   DtRwStringList mySendContactReportsForObjectsOnOverlayLayers;
   
   DtRwReal myExpirationTime;
   
   DtRwReal mySendContactReportsOnOverlayLayersWithin;

   DtRwBoolean mySendContactReportsOnOwnForce;

   DtRwBoolean mySendContactReportsOnHostileForces;

   DtRwBoolean mySendContactReportsOnNeutralForces;

   DtRwBoolean mySendContactReportsOnSensorContacts;

};