DtCloudLayerRecord.h

Go to the documentation of this file.

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


#pragma once
#include <makArchives/makArchives.h>

namespace makArchives
{
   class DT_DLL_MAKARCHIVES DtCloudLayerRecord
   {
   public:
      DtCloudLayerRecord();

      DtCloudLayerRecord(const DtCloudLayerRecord& orig);

      DtCloudLayerRecord& operator=(const DtCloudLayerRecord& orig);

      ~DtCloudLayerRecord();

      //Test for equality.
      bool operator==(const DtCloudLayerRecord& other) const;
      
      //Test for inequality.
      bool operator!=(const DtCloudLayerRecord& other) const;

      //Is the cloud layer visible.
      void setEnabledFlag(bool enabled);
      bool enabledFlag() const;

      // Does the cloud layer extend forever
      void setInfiniteFlag(bool infinite);
      bool infiniteFlag() const;

      //The type of cloud layer.
      void setType(const std::string& type );
      const std::string& type() const;

      //Location
      void setPosition(double x, double y, double z);
      void setPosition(double position[3]);

      const double* position() const;

      //Size
      void setWidth(double w);
      void setLength(double l);
      void setThickness(double t);

      double width() const;
      double length() const;
      double thickness() const;

      //Parameters
      void setDensity(float density);
      float density() const;

      void setSkyCoverage(float skyCoverage);
      float skyCoverage() const;

   protected:

      friend class boost::serialization::access;

      template<class Archive>
      void serialize(Archive & ar, const unsigned int version)
      {
         if (version < 3)
         {
            ar & BOOST_SERIALIZATION_NVP(myEnabledFlag);
         }
         ar & BOOST_SERIALIZATION_NVP(myType);

         if(version < 1)
         {
            ar & boost::serialization::make_nvp("myOriginX", myPosition[0]);
            ar & boost::serialization::make_nvp("myOriginY", myPosition[1]);
            ar & boost::serialization::make_nvp("myAltitude", myPosition[2]);
         }
         else if (version < 3)
         {
            ar & BOOST_SERIALIZATION_NVP(myPosition);
         }
            ar & BOOST_SERIALIZATION_NVP(myWidth);
            ar & BOOST_SERIALIZATION_NVP(myLength);

         if (version < 3)
         {
            ar & BOOST_SERIALIZATION_NVP(myThickness);
         }

         ar & BOOST_SERIALIZATION_NVP(myDensity);
         if (version >= 3)
         {
            ar & BOOST_SERIALIZATION_NVP(mySkyCoverage);
         }
         if (version == 2)
         {
            ar & BOOST_SERIALIZATION_NVP(myInfiniteFlag);
         }

         if (version >= 3)
         {
            // initialize deprecated parameters
            myPosition[0] = 0.0;
            myPosition[1] = 0.0;
            myPosition[2] = 0.0;
            myEnabledFlag = true;
            myInfiniteFlag = true;
            myThickness = 0.0;
         }
      }

      //The name of the type of cloud layer.
      std::string myType;

      //The density, in kg/m^3, of the cloud layer. Only used by VRForces.
      float myDensity;

      //The sky coverage (in normalized [0-1] Oktas) of the cloud layer.
      float mySkyCoverage;

      //The length and width of the cloud layer
      double myWidth;
      double myLength;

      //Deprecated Parameters in version >= 3
      double myPosition[3];
      bool myEnabledFlag;
      bool myInfiniteFlag;
      double myThickness;
   };
}

BOOST_CLASS_VERSION(makArchives::DtCloudLayerRecord, 3)