vrfCloudLayerStateRecord.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 <vlpi/disEnums.h>
#include <vrfExtObjects/vrfCloudLayerStateEnums.h>

// Definition of the FIXED PORTION of the cloud layer object.

struct DtNetCloudLayerStateRecord
{
   DtNetEnvironmentalRecord   myHeader;
   DtNetU32                   myRecordVersion;  // Version of this record.  This will change in order to be able to read older versions of the record
   DtNetU32                   myCloudType;
   DtNetFloat64               myCloudAltitude;  // The base (bottom) of the cloud layer (in meters)
   DtNetFloat64               myCloudThickness; // The thickness of the cloud layer (in meters)
   DtNetFloat64               myCloudDensity;   // Density of cloud layer (between 0 - 1)
   DtNetU8                    myCloudLayerEnabled;   // 1 if enabled, 0 if not
   DtNetFloat64               myCornerRadius;   // The “roundness” of the corners is determined by the Corner Radius
                                                // parameter. Setting this radius to zero (0) shall create a rectangle.
                                                // Setting the value equal to one-half that of Size X and Size Y when both
                                                // are equal shall create a circle. The corner radius shall be less than or
                                                // equal to one half of the smaller of Size X or Size Y."
   DtNetFloat64               myUnused2;
   DtNetFloat64               myUnused3;
   DtNetU32                   myUnused4;
   DtNetU32                   myFlags;
};

//
// Class Description: DtVrfCloudLayerStateRecord
//
class DT_DLL_vrfExtObjects DtVrfCloudLayerStateRecord :
   public DtEnvironmentalRecord
{
public:
   // Default Constructor.
   DtVrfCloudLayerStateRecord();

   DtVrfCloudLayerStateRecord(
      const DtVrfCloudLayerStateRecord& orig);

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

   // Destructor
   virtual ~DtVrfCloudLayerStateRecord() override;

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

   // See #myCloudType
   virtual void setCloudType(CloudLayerCloudType value);
   virtual CloudLayerCloudType cloudType() const;

   // See #myCloudAltitude
   virtual void setCloudAltitude(double value);
   virtual double cloudAltitude() const;

   // See #myCornerRadius
   virtual void setCornerRadius(double value);
   virtual double cornerRadius() const;

   // See #myCloudLayerEnabled
   virtual void setCloudLayerEnabled(bool value);
   virtual bool cloudLayerEnabled() const;

   // See #myCloudThickness
   virtual void setCloudThickness(double value);
   virtual double cloudThickness() const;

   // See #myCloudDensity
    virtual void setCloudDensity(double value);
    virtual double cloudDensity() const;

    // See #myFlags
    virtual void setFlags(DtU32 value);
    virtual DtU32 flags() 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;

   // returns the network representation of the environmental record
   virtual const DtNetCloudLayerStateRecord* objStateNetRep() const;
   virtual DtNetCloudLayerStateRecord* objStateNetRep();

   // used by the PDU class to fill in the network representation
   virtual void setFromNet(const DtNetEnvironmentalRecord &buffer,
                            int protocolVersion) override;

   virtual int netRepSize() const override;

protected:

   virtual bool resizeNetRep(int newSize) override;

   // Casts the 'this' pointer for changing elements in a const function.
   DtVrfCloudLayerStateRecord* self() const;

protected:
   int myNetRepSize;
};