envSmokeStateRecord.h

Go to the documentation of this file.

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


#pragma once

#include <vrfExtObjects/dllExport.h>
#include <vl/globalObjectDesignatorList.h>
#include <vl/environmentalRecord.h>
#include <vl/packets/envProcP.h>
#include <vlpi/appearance.h>
#include <vlpi/disEnums.h>

struct DtNetEnvSmokeStateRecord :DtNetEnvironmentalRecord
{
   DtNetU16                 mySmokeAgent;      // Not Used
   DtNetU16                 myGeomIndex;
   DtNetFloat32             myAgentMass;       // Not Used
   DtNetFloat32             myDensityRate;     // %/ sec. Rate for changing the cloud density
   DtNetFloat32             myDensity;         // 0.0% to 100.0% Cloud density
};

// \brief DtEnvSmokeStateRecord implements tactical smoke
// state to be sent/received via EnvironmentProcess
class DT_DLL_vrfExtObjects DtEnvSmokeStateRecord : public DtEnvironmentalRecord
{
public:

   // Default Constructor.
   DtEnvSmokeStateRecord();

   DtEnvSmokeStateRecord(
      const DtEnvSmokeStateRecord& orig);

   // Assignment Operator
   const DtEnvSmokeStateRecord& operator=(
      const DtEnvSmokeStateRecord& orig);

   // Destructor
   virtual ~DtEnvSmokeStateRecord() override;

   // Clone.  Return a copy of this instance.
   virtual DtEnvironmentalRecord *clone() const override;

   virtual bool setDensity(double d);
   virtual double density() const;

   virtual bool setDensityRate(double d);
   virtual double densityRate() const;

   virtual bool setGeometryIndex(int d);
   virtual int geometryIndex() const;

   // This doesn't need to be called explicitly.  If any routine that needs
   // the repository finds that it hasn't been created yet, it calls this
   // method.
   virtual bool createNetworkRepresentation() override;

   virtual int netRepSize() const override;
   virtual void setFromNet(const DtNetEnvironmentalRecord &buffer,
                           int protocolVersion) override;

protected:

   int myGeometryIndex;
   float myDensity;
   float myDensityRate;

};