GiEnvironmentTraitsData.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef __OD_GI_ENVIRONMENT_TRAITS_DATA__
#define __OD_GI_ENVIRONMENT_TRAITS_DATA__
 
#include "TD_PackPush.h"
 
#include "Gi/GiEnvironment.h"
#include "Gi/GiLightTraits.h" // Define OdGiSkyParameters

class OdGiBackgroundTraitsData
{
protected:
  OdGiDrawable::DrawableType m_type;
 
protected:
  OdGiBackgroundTraitsData()
    : m_type(OdGiDrawable::kGeometry)
  {
  }
 
public:
  OdGiDrawable::DrawableType type() const { return m_type; }

  static void deleteBackgroundTraitsData(OdGiBackgroundTraitsData* pBackgroundTraits);

  bool operator ==(const OdGiBackgroundTraitsData &data2) const
  {
    return m_type == data2.m_type;
  }
  
  bool operator !=(const OdGiBackgroundTraitsData &data2) const
  {
    return m_type != data2.m_type;
  }
};

class OdGiSolidBackgroundTraitsData : public OdGiBackgroundTraitsData
{
  OdCmEntityColor      m_color;
 
public:
  OdGiSolidBackgroundTraitsData() { m_type = OdGiDrawable::kSolidBackground; }

  OdCmEntityColor color() const { return m_color; }
  
  void setColor(const OdCmEntityColor& color) { m_color = color; }

  bool operator ==(const OdGiSolidBackgroundTraitsData &data2) const
  {
    return ((*static_cast<const OdGiBackgroundTraitsData*>(this) == static_cast<const OdGiBackgroundTraitsData&>(data2)) &&
           (m_color == data2.m_color));
  }
  
  bool operator !=(const OdGiSolidBackgroundTraitsData &data2) const
  {
    return !(*this == data2);
  }
};

class OdGiGradientBackgroundTraitsData : public OdGiBackgroundTraitsData
{
  OdCmEntityColor      m_colorTop;
  OdCmEntityColor      m_colorMiddle;
  OdCmEntityColor      m_colorBottom;
  double               m_dHorizon;
  double               m_dHeight;
  double               m_dRotation;
 
public:
  OdGiGradientBackgroundTraitsData() : m_dHorizon(0.0), m_dHeight(0.0), m_dRotation(0.0) { m_type = OdGiDrawable::kGradientBackground; }

  OdCmEntityColor colorTop() const { return m_colorTop; }
  
  void setColorTop(const OdCmEntityColor& color) { m_colorTop = color; }
  
  OdCmEntityColor colorMiddle() const { return m_colorMiddle; }
  
  void setColorMiddle(const OdCmEntityColor& color) { m_colorMiddle = color; }
  
  OdCmEntityColor colorBottom() const { return m_colorBottom; }
  
  void setColorBottom(const OdCmEntityColor& color) { m_colorBottom = color; }
  
  
  double horizon() const { return m_dHorizon; }
  
  double height() const { return m_dHeight; }
  
  double rotation() const { return m_dRotation; }
 
  
  void setHorizon(double value) { m_dHorizon = value; }
  
  void setHeight(double value) { m_dHeight = value; }
  
  void setRotation(double value) { m_dRotation = value; }
 
  
  bool operator ==(const OdGiGradientBackgroundTraitsData &data2) const
  {
    return ((*static_cast<const OdGiBackgroundTraitsData*>(this) == static_cast<const OdGiBackgroundTraitsData&>(data2)) &&
           (m_colorTop == data2.m_colorTop) &&
           (m_colorMiddle == data2.m_colorMiddle) &&
           (m_colorBottom == data2.m_colorBottom) &&
           OdEqual(m_dHorizon, data2.m_dHorizon) &&
           OdEqual(m_dHeight, data2.m_dHeight) &&
           OdEqual(m_dRotation, data2.m_dRotation));
  }
  
  bool operator !=(const OdGiGradientBackgroundTraitsData &data2) const
  {
    return !(*this == data2);
  }
};

class OdGiImageBackgroundTraitsData : public OdGiBackgroundTraitsData
{
  OdString             m_imageFileName;
  bool                 m_bFitToScreen;
  bool                 m_bMaintainAspect;
  bool                 m_bUseTiling;
  OdGeVector2d         m_vOffset;
  OdGeVector2d         m_vScale;
 
public:
  
  OdGiImageBackgroundTraitsData() : m_bFitToScreen(false), m_bMaintainAspect(false), m_bUseTiling(false) { m_type = OdGiDrawable::kImageBackground; }

  const OdString& imageFilename() const { return m_imageFileName; }
  
  void setImageFilename(const OdString& filename) { m_imageFileName = filename; }

  bool fitToScreen() const { return m_bFitToScreen; }
  
  bool maintainAspectRatio() const { return m_bMaintainAspect; }
  
  bool useTiling() const { return m_bUseTiling; }

  void setFitToScreen(bool flag) { m_bFitToScreen = flag; }
  
  void setMaintainAspectRatio(bool flag) { m_bMaintainAspect = flag; }
  
  void setUseTiling(bool flag) { m_bUseTiling = flag; }

  void setOffset(double x, double y);

  double xOffset() const { return m_vOffset.x; }
  
  double yOffset() const { return m_vOffset.y; }

  void setXOffset(double xOffset) { m_vOffset.x = xOffset; }
  
  void setYOffset(double yOffset) { m_vOffset.y = yOffset; }

  void setScale(double x, double y);

  double xScale() const { return m_vScale.x; }
  
  double yScale() const { return m_vScale.y; }

  void setXScale(double xScale) { m_vScale.x = xScale; }
  
  void setYScale(double yScale) { m_vScale.y = yScale; }

  bool operator ==(const OdGiImageBackgroundTraitsData &data2) const
  {
    return ((*static_cast<const OdGiBackgroundTraitsData*>(this) == static_cast<const OdGiBackgroundTraitsData&>(data2)) &&
           (m_imageFileName == data2.m_imageFileName) &&
           (m_bFitToScreen == data2.m_bFitToScreen) &&
           (m_bMaintainAspect == data2.m_bMaintainAspect) &&
           (m_bUseTiling == data2.m_bUseTiling) &&
           (m_vOffset == data2.m_vOffset) &&
           (m_vScale == data2.m_vScale));
  }
  
  bool operator !=(const OdGiImageBackgroundTraitsData &data2) const
  {
    return !(*this == data2);
  }
};
 
inline void OdGiImageBackgroundTraitsData::setOffset(double x, double y)
{ 
  m_vOffset.set(x, y);
}
 
inline void OdGiImageBackgroundTraitsData::setScale(double x, double y)
{ 
  m_vScale.set(x, y);
}

class OdGiGroundPlaneBackgroundTraitsData : public OdGiBackgroundTraitsData
{
  OdCmEntityColor      m_colorSkyZenith;
  OdCmEntityColor      m_colorSkyHorizon;
  OdCmEntityColor      m_colorUndergroundHorizon;
  OdCmEntityColor      m_colorUndergroundAzimuth;
  OdCmEntityColor      m_colorGroundPlaneNear;
  OdCmEntityColor      m_colorGroundPlaneFar;
 
public:
  OdGiGroundPlaneBackgroundTraitsData() { m_type = OdGiDrawable::kGroundPlaneBackground; }
 
  
  OdCmEntityColor colorSkyZenith() const { return m_colorSkyZenith; }
  
  void setColorSkyZenith(const OdCmEntityColor& color) { m_colorSkyZenith = color; }
  
  OdCmEntityColor colorSkyHorizon() const { return m_colorSkyHorizon; }
  
  void setColorSkyHorizon(const OdCmEntityColor& color) { m_colorSkyHorizon = color; }
  
  OdCmEntityColor colorUndergroundHorizon() const { return m_colorUndergroundHorizon; }
  
  void setColorUndergroundHorizon(const OdCmEntityColor& color) { m_colorUndergroundHorizon = color; }
  
  OdCmEntityColor colorUndergroundAzimuth() const { return m_colorUndergroundAzimuth; }
  
  void setColorUndergroundAzimuth(const OdCmEntityColor& color) { m_colorUndergroundAzimuth = color; }
  
  OdCmEntityColor colorGroundPlaneNear() const { return m_colorGroundPlaneNear; }
  
  void setColorGroundPlaneNear(const OdCmEntityColor& color) { m_colorGroundPlaneNear = color; }
  
  OdCmEntityColor colorGroundPlaneFar() const { return m_colorGroundPlaneFar; }
  
  void setColorGroundPlaneFar(const OdCmEntityColor& color) { m_colorGroundPlaneFar = color; }

  bool operator ==(const OdGiGroundPlaneBackgroundTraitsData &data2) const
  {
    return ((*static_cast<const OdGiBackgroundTraitsData*>(this) == static_cast<const OdGiBackgroundTraitsData&>(data2)) &&
           (m_colorSkyZenith == data2.m_colorSkyZenith) &&
           (m_colorSkyHorizon == data2.m_colorSkyHorizon) &&
           (m_colorUndergroundHorizon == data2.m_colorUndergroundHorizon) &&
           (m_colorUndergroundAzimuth == data2.m_colorUndergroundAzimuth) &&
           (m_colorGroundPlaneNear == data2.m_colorGroundPlaneNear) &&
           (m_colorGroundPlaneFar == data2.m_colorGroundPlaneFar));
  }
  
  bool operator !=(const OdGiGroundPlaneBackgroundTraitsData &data2) const
  {
    return !(*this == data2);
  }
};

class OdGiSkyBackgroundTraitsData : public OdGiBackgroundTraitsData
{
  bool            m_status;
  double          m_intensityFactor;
  double          m_haze;
  double          m_horizonHeight;
  double          m_horizonBlur;
  OdCmEntityColor m_groundColor;
  OdCmEntityColor m_nightColor;
  bool            m_aerialPerspective;
  double          m_visibilityDistance;
  double          m_diskScale;
  double          m_glowIntensity;
  double          m_diskIntensity;
  OdUInt16        m_solarDiskSamples;
  OdGeVector3d    m_sunDirection;
  double          m_redBlueShift;
  double          m_saturation;
public:
  OdGiSkyBackgroundTraitsData()
    : m_status(false)
    , m_intensityFactor(0.)
    , m_haze(0.)
    , m_horizonHeight(0.)
    , m_horizonBlur(0.)
    , m_aerialPerspective(false)
    , m_visibilityDistance(0.)
    , m_diskScale(0.)
    , m_glowIntensity(0.)
    , m_diskIntensity(0.)
    , m_solarDiskSamples(0)
    , m_redBlueShift(0.)
    , m_saturation(0.)
  { m_type = OdGiDrawable::kSkyBackground; }

  void skyParameters(OdGiSkyParameters& params) const;
  
  void setSkyParameters(const OdGiSkyParameters& params);

  bool operator ==(const OdGiSkyBackgroundTraitsData &data2) const
  {
    return ((*static_cast<const OdGiBackgroundTraitsData*>(this) == static_cast<const OdGiBackgroundTraitsData&>(data2)) &&
           (m_status == data2.m_status) &&
           OdEqual(m_intensityFactor, data2.m_intensityFactor) &&
           OdEqual(m_haze, data2.m_haze) &&
           OdEqual(m_horizonHeight, data2.m_horizonHeight) &&
           OdEqual(m_horizonBlur, data2.m_horizonBlur) &&
           (m_groundColor == data2.m_groundColor) &&
           (m_nightColor == data2.m_nightColor) &&
           (m_aerialPerspective == data2.m_aerialPerspective) &&
           OdEqual(m_visibilityDistance, data2.m_visibilityDistance) &&
           OdEqual(m_diskScale, data2.m_diskScale) &&
           OdEqual(m_glowIntensity, data2.m_glowIntensity) &&
           OdEqual(m_diskIntensity, data2.m_diskIntensity) &&
           (m_solarDiskSamples == data2.m_solarDiskSamples) &&
           (m_sunDirection == data2.m_sunDirection) &&
           OdEqual(m_redBlueShift, data2.m_redBlueShift) &&
           OdEqual(m_saturation, data2.m_saturation));
  }
  
  bool operator !=(const OdGiSkyBackgroundTraitsData &data2) const
  {
    return !(*this == data2);
  }
};
 
inline void OdGiSkyBackgroundTraitsData::skyParameters(OdGiSkyParameters& params) const
{
  params.setIllumination(m_status);
  params.setIntensityFactor(m_intensityFactor);
  params.setHaze(m_haze);
  params.setHorizonHeight(m_horizonHeight);
  params.setHorizonBlur(m_horizonBlur);
  params.setGroundColor(m_groundColor);
  params.setNightColor(m_nightColor);
  params.setAerialPerspective(m_aerialPerspective);
  params.setVisibilityDistance(m_visibilityDistance);
  params.setDiskScale(m_diskScale);
  params.setGlowIntensity(m_glowIntensity);
  params.setDiskIntensity(m_diskIntensity);
  params.setSolarDiskSamples(m_solarDiskSamples);
  params.setSunDirection(m_sunDirection);
  params.setRedBlueShift(m_redBlueShift);
  params.setSaturation(m_saturation);
}
 
inline void OdGiSkyBackgroundTraitsData::setSkyParameters(const OdGiSkyParameters& params)
{
  m_status = params.illumination();
  m_intensityFactor = params.intensityFactor();
  m_haze = params.haze();
  m_horizonHeight = params.horizonHeight();
  m_horizonBlur = params.horizonBlur();
  m_groundColor = params.groundColor();
  m_nightColor = params.nightColor();
  m_aerialPerspective = params.aerialPerspective();
  m_visibilityDistance = params.visibilityDistance();
  m_diskScale = params.diskScale();
  m_glowIntensity = params.glowIntensity();
  m_diskIntensity = params.diskIntensity();
  m_solarDiskSamples = params.solarDiskSamples();
  m_sunDirection = params.sunDirection();
  m_redBlueShift = params.redBlueShift();
  m_saturation = params.saturation();
}

class OdGiIBLBackgroundTraitsData : public OdGiBackgroundTraitsData
{
  bool      m_bEnable;
  OdString  m_iblFileName;
  double    m_rotation;
  bool      m_bDisplay;
  OdDbStub *m_secBkgndId;
 
public:
  
  OdGiIBLBackgroundTraitsData() 
    : m_bEnable(false)
    , m_rotation(0.)
    , m_bDisplay(false)
    , m_secBkgndId(NULL)
  { m_type = OdGiDrawable::kImageBasedLightingBackground; }

  bool isEnabled() const { return m_bEnable; }
  
  void enable(bool bSet) { m_bEnable = bSet; }

  const OdString &IBLFileName() const { return m_iblFileName; }
  
  void setIBLFileName(const OdString &iblFileName) { m_iblFileName = iblFileName; }

  double rotation() const { return m_rotation; }
  
  void setRotation(double angle) { m_rotation = angle; }

  bool displayImage() const { return m_bDisplay; }
  
  void setDisplayImage(bool bSet) { m_bDisplay = bSet; }

  OdDbStub *secondaryBackground() const { return m_secBkgndId; }
  
  void setSecondaryBackground(OdDbStub *secBkgndId) { m_secBkgndId = secBkgndId; }

  bool operator ==(const OdGiIBLBackgroundTraitsData &data2) const
  {
    return ((*static_cast<const OdGiBackgroundTraitsData*>(this) == static_cast<const OdGiBackgroundTraitsData&>(data2)) &&
           (m_bEnable == data2.m_bEnable) &&
           (m_iblFileName == data2.m_iblFileName) &&
           OdEqual(m_rotation, data2.m_rotation) &&
           (m_bDisplay == data2.m_bDisplay) &&
           (m_secBkgndId == data2.m_secBkgndId));
  }
  
  bool operator !=(const OdGiIBLBackgroundTraitsData &data2) const
  {
    return !(*this == data2);
  }
};

class OdGiEnvironmentBackgroundTraitsData : public OdGiBackgroundTraitsData
{
  double m_longRot;
  double m_latRot;
  double m_fovAngle;
  bool m_bFovOverride;
public:
  OdGiEnvironmentBackgroundTraitsData() : m_longRot(0.0), m_latRot(0.0), m_fovAngle(OdaToRadian(45.0)), m_bFovOverride(false)
  { m_type = OdGiDrawable::kEnvironmentBackground; }

  void setRotation(double longRad, double latRad)
  {
    m_longRot = longRad;
    m_latRot = latRad;
  }

  double longitudeRotation() const
  {
    return m_longRot;
  }

  double latitudeRotation() const
  {
    return m_latRot;
  }

  void enableFovOverride(bool bEnable)
  {
    m_bFovOverride = bEnable;
  }

  bool fovOverride() const
  {
    return m_bFovOverride;
  }

  void setFovOverrideAngle(double fovRad)
  {
    m_fovAngle = fovRad;
  }

  double fovOverrideAngle() const
  {
    return m_fovAngle;
  }

  bool operator ==(const OdGiEnvironmentBackgroundTraitsData &data2) const
  {
    return ((*static_cast<const OdGiBackgroundTraitsData*>(this) == static_cast<const OdGiBackgroundTraitsData&>(data2)) &&
            OdEqual(m_longRot, data2.m_longRot) && OdEqual(m_latRot, data2.m_latRot) &&
            (m_bFovOverride == data2.m_bFovOverride) && (!m_bFovOverride || OdEqual(m_fovAngle, data2.m_fovAngle)));
  }
  
  bool operator !=(const OdGiEnvironmentBackgroundTraitsData &data2) const
  {
    return !(*this == data2);
  }
};

class FIRSTDLL_EXPORT OdGiCustomBackgroundTraitsData : public OdGiBackgroundTraitsData
{
  void *m_pData;
protected:
  void clear();
  bool compare(const OdGiCustomBackgroundTraitsData &data2) const;
public:
  OdGiCustomBackgroundTraitsData() : m_pData(NULL)
  { m_type = OdGiDrawable::kCustomBackground; }

  ~OdGiCustomBackgroundTraitsData() { clear(); }

  void setProperty(const OdChar *pName, const OdGiVariant *pData);

  const OdGiVariant *property(const OdChar *pName) const;
  
  bool operator ==(const OdGiCustomBackgroundTraitsData &data2) const
  {
    return (*static_cast<const OdGiBackgroundTraitsData*>(this) == static_cast<const OdGiBackgroundTraitsData&>(data2)) &&
            compare(data2);
  }
  
  bool operator !=(const OdGiCustomBackgroundTraitsData &data2) const
  {
    return !(*this == data2);
  }
};
 
// Delete background traits data by background type
 
inline void OdGiBackgroundTraitsData::deleteBackgroundTraitsData(OdGiBackgroundTraitsData* pBackgroundTraits)
{
  switch (pBackgroundTraits->type())
  {
    case OdGiDrawable::kSolidBackground:
      delete static_cast<OdGiSolidBackgroundTraitsData*>(pBackgroundTraits);
    break;
    case OdGiDrawable::kGradientBackground:
      delete static_cast<OdGiGradientBackgroundTraitsData*>(pBackgroundTraits);
    break;
    case OdGiDrawable::kImageBackground:
      delete static_cast<OdGiImageBackgroundTraitsData*>(pBackgroundTraits);
    break;
    case OdGiDrawable::kGroundPlaneBackground:
      delete static_cast<OdGiGroundPlaneBackgroundTraitsData*>(pBackgroundTraits);
    break;
    case OdGiDrawable::kSkyBackground:
      delete static_cast<OdGiSkyBackgroundTraitsData*>(pBackgroundTraits);
    break;
    case OdGiDrawable::kImageBasedLightingBackground:
      delete static_cast<OdGiIBLBackgroundTraitsData*>(pBackgroundTraits);
    break;
    case OdGiDrawable::kEnvironmentBackground:
      delete static_cast<OdGiEnvironmentBackgroundTraitsData*>(pBackgroundTraits);
    break;
    case OdGiDrawable::kCustomBackground:
      delete static_cast<OdGiCustomBackgroundTraitsData*>(pBackgroundTraits);
    break;
    default:
      ODA_FAIL();
  }
}

class OdGiRenderEnvironmentTraitsData
{
  bool                   m_bEnable;
  bool                   m_bIsBackground;
  OdCmEntityColor        m_FogColor;
  double                 m_dNearDist;
  double                 m_dFarDist;
  double                 m_dNearPerc;
  double                 m_dFarPerc;
  OdGiMaterialTexturePtr m_envMap;
public:
  
  OdGiRenderEnvironmentTraitsData()
    : m_bEnable(false)
    , m_bIsBackground(false)
    , m_FogColor(128, 128, 128)
    , m_dNearDist(0.0)
    , m_dFarDist(100.0)
    , m_dNearPerc(0.0)
    , m_dFarPerc(100.0)
  {
  }

  void setEnable(bool bEnable) { m_bEnable = bEnable; }
  
  bool enable() const { return m_bEnable; }
  
  void setIsBackground(bool bEnable) { m_bIsBackground = bEnable; }
  
  bool isBackground() const { return m_bIsBackground; }
  
  void setFogColor(const OdCmEntityColor &color) { m_FogColor = color; }
  
  const OdCmEntityColor &fogColor() const { return m_FogColor; }
  
  void setNearDistance(double nearDist) { m_dNearDist = nearDist; }
  
  double nearDistance() const { return m_dNearDist; }
  
  void setFarDistance(double farDist) { m_dFarDist = farDist; }
  
  double farDistance() const { return m_dFarDist; }
  
  void setNearPercentage(double nearPct) { m_dNearPerc = nearPct; }
  
  double nearPercentage() const { return m_dNearPerc; }
  
  void setFarPercentage(double farPct) { m_dFarPerc = farPct; }
  
  double farPercentage() const { return m_dFarPerc; }
  
  void setEnvironmentMap(const OdGiMaterialTexture *map)
  {
    m_envMap.release();
    if (map)
    {
      m_envMap = OdGiMaterialTexture::cast(map->clone());
    }
  }
  
  OdGiMaterialTexturePtr environmentMap() const { return m_envMap; }

  bool operator ==(const OdGiRenderEnvironmentTraitsData &data2) const
  {
    return ((m_bEnable == data2.m_bEnable) &&
           (m_bIsBackground == data2.m_bIsBackground) &&
           (m_FogColor == data2.m_FogColor) &&
           OdEqual(m_dNearDist, data2.m_dNearDist) &&
           OdEqual(m_dFarDist, data2.m_dFarDist) &&
           OdEqual(m_dNearPerc, data2.m_dNearPerc) &&
           OdEqual(m_dFarPerc, data2.m_dFarPerc) &&
           ((m_envMap.isNull() && data2.m_envMap.isNull()) ||
            (!m_envMap.isNull() && !data2.m_envMap.isNull() && (*m_envMap == *data2.m_envMap))));
  }
  
  bool operator !=(const OdGiRenderEnvironmentTraitsData &data2) const
  {
    return !(*this == data2);
  }
};

class OdGiRenderSettingsTraitsData
{
  bool   m_bMatEnable;
  bool   m_bTextureSampling;
  bool   m_bBackFaces;
  bool   m_bShadows;
  bool   m_bDiagnosticBack;
  double m_dScaleFactor;
public:
  OdGiRenderSettingsTraitsData()
    : m_bMatEnable(true)
    , m_bTextureSampling(true)
    , m_bBackFaces(true)
    , m_bShadows(true)
    , m_bDiagnosticBack(false)
    , m_dScaleFactor(1.0)
  {
  }
  
  virtual ~OdGiRenderSettingsTraitsData() { } // Exclude warnings in some compilers

  void setMaterialEnabled(bool enabled) { m_bMatEnable = enabled; }
  
  bool materialEnabled() const { return m_bMatEnable; }
  
  void setTextureSampling(bool enabled) { m_bTextureSampling = enabled; }
  
  bool textureSampling() const { return m_bTextureSampling; }
  
  void setBackFacesEnabled(bool enabled) { m_bBackFaces = enabled; }
  
  bool backFacesEnabled() const { return m_bBackFaces; }
  
  void setShadowsEnabled(bool enabled) { m_bShadows = enabled; }
  
  bool shadowsEnabled() const { return m_bShadows; }
  
  void setDiagnosticBackgroundEnabled(bool enabled) { m_bDiagnosticBack = enabled; }
  
  bool diagnosticBackgroundEnabled() const { return m_bDiagnosticBack; }
  
  void setModelScaleFactor(double scaleFactor) { m_dScaleFactor = scaleFactor; }
  
  double modelScaleFactor() const { return m_dScaleFactor; }

  bool operator ==(const OdGiRenderSettingsTraitsData &data2) const
  {
    return ((m_bMatEnable == data2.m_bMatEnable) &&
           (m_bTextureSampling == data2.m_bTextureSampling) &&
           (m_bBackFaces == data2.m_bBackFaces) &&
           (m_bShadows == data2.m_bShadows) &&
           (m_bDiagnosticBack == data2.m_bDiagnosticBack) &&
           OdEqual(m_dScaleFactor, data2.m_dScaleFactor));
  }
  
  bool operator !=(const OdGiRenderSettingsTraitsData &data2) const
  {
    return !(*this == data2);
  }
};

class OdGiMentalRayRenderSettingsTraitsData : public virtual OdGiRenderSettingsTraitsData
{
  int                        m_iSamplingMin;
  int                        m_iSamplingMax;
  OdGiMrFilter               m_SamplingFilter;
  double                     m_dSamplingWidth;
  double                     m_dSamplingHeight;
  float                      m_fContrastR;
  float                      m_fContrastG;
  float                      m_fContrastB;
  float                      m_fContrastA;
  OdGiMrShadowMode           m_ShadowMode;
  bool                       m_bShadowMapEnabled;
  bool                       m_bRayTraceEnabled;
  int                        m_iRTReflection;
  int                        m_iRTRefraction;
  int                        m_iRTSum;
  bool                       m_bGlobalIllum;
  int                        m_iGISampleCount;
  bool                       m_bSampleRadEnabled;
  double                     m_dSampleRad;
  int                        m_iPhotonsPerLight;
  int                        m_iPhotonsReflection;
  int                        m_iPhotonsRefraction;
  int                        m_iPhotonsSum;
  bool                       m_bFGEnabled;
  int                        m_iFGRayCount;
  bool                       m_bFGRadMin;
  bool                       m_bFGRadMax;
  bool                       m_bFGPixels;
  double                     m_dFGSRadMin;
  double                     m_dFGSRadMax;
  double                     m_dLightLumScale;
  OdGiMrDiagnosticMode       m_DiagMode;
  OdGiMrDiagnosticGridMode   m_DiagGridMode;
  float                      m_fDiagGridSize;
  OdGiMrDiagnosticPhotonMode m_DiagPhtMode;
  OdGiMrDiagnosticBSPMode    m_DiagBSPMode;
  bool                       m_bExportMIEnabled;
  OdString                   m_sMIFile;
  int                        m_iTileSize;
  OdGiMrTileOrder            m_TileOrder;
  int                        m_iMemLimit;
  float                      m_fEnergyMult;
  void*                      m_pProgressMonitor;
  OdGiMrExposureType         m_ExposureType;
  OdGiMrFinalGatheringMode   m_FGMode;
  double                     m_dShadowMult;
  OdGiMrExportMIMode         m_MIMode;
public:
  
  OdGiMentalRayRenderSettingsTraitsData()
    : OdGiRenderSettingsTraitsData()
    , m_iSamplingMin(-1)
    , m_iSamplingMax(0)
    , m_SamplingFilter(krBox)
    , m_dSamplingWidth(1.0)
    , m_dSamplingHeight(1.0)
    , m_fContrastR(0.1f)
    , m_fContrastG(0.1f)
    , m_fContrastB(0.1f)
    , m_fContrastA(0.1f)
    , m_ShadowMode(krSimple)
    , m_bShadowMapEnabled(true)
    , m_bRayTraceEnabled(true)
    , m_iRTReflection(2)
    , m_iRTRefraction(2)
    , m_iRTSum(4)
    , m_bGlobalIllum(false)
    , m_iGISampleCount(500)
    , m_bSampleRadEnabled(false)
    , m_dSampleRad(1.0)
    , m_iPhotonsPerLight(10000)
    , m_iPhotonsReflection(5)
    , m_iPhotonsRefraction(5)
    , m_iPhotonsSum(5)
    , m_bFGEnabled(false)
    , m_iFGRayCount(1000)
    , m_bFGRadMin(false)
    , m_bFGRadMax(false)
    , m_bFGPixels(false)
    , m_dFGSRadMin(1.0)
    , m_dFGSRadMax(1.0)
    , m_dLightLumScale(1.0)
    , m_DiagMode(krOff)
    , m_DiagGridMode(krObject)
    , m_fDiagGridSize(10.0f)
    , m_DiagPhtMode(krDensity)
    , m_DiagBSPMode(krDepth)
    , m_bExportMIEnabled(false)
    , m_sMIFile()
    , m_iTileSize(32)
    , m_TileOrder(krHilbert)
    , m_iMemLimit(1048)
    , m_fEnergyMult(1.0f)
    , m_pProgressMonitor(NULL)
    , m_ExposureType(krAutomatic)
    , m_FGMode(krFinalGatherAuto)
    , m_dShadowMult(1.0)
    , m_MIMode(krExportMIOff)
  {
  }

  void setSampling(int min, int max)
  {
    m_iSamplingMin = min;
    m_iSamplingMax = max;
  }
  
  void sampling(int& min, int& max) const
  {
    min = m_iSamplingMin;
    max = m_iSamplingMax;
  }
  
  void setSamplingFilter(OdGiMrFilter filter, double width, double height)
  {
    m_SamplingFilter = filter;
    m_dSamplingWidth = width;
    m_dSamplingHeight = height;
  }
  
  void samplingFilter(OdGiMrFilter& filter, double& width, double& height) const
  {
    filter = m_SamplingFilter;
    width = m_dSamplingWidth;
    height = m_dSamplingHeight;
  }
  
  void setSamplingContrastColor(float r, float g, float b, float a)
  {
    m_fContrastR = r;
    m_fContrastG = g;
    m_fContrastB = b;
    m_fContrastA = a;
  }
  
  void samplingContrastColor(float& r, float& g, float& b, float& a) const
  {
    r = m_fContrastR;
    g = m_fContrastG;
    b = m_fContrastB;
    a = m_fContrastA;
  }
  
  void setShadowMode(OdGiMrShadowMode mode)
  {
    m_ShadowMode = mode;
  }
  
  OdGiMrShadowMode shadowMode() const
  {
    return m_ShadowMode;
  }
  
  void setShadowMapEnabled(bool enabled)
  {
    m_bShadowMapEnabled = enabled;
  }
  
  bool shadowMapEnabled() const
  {
    return m_bShadowMapEnabled;
  }
  
  void setRayTraceEnabled(bool enabled)
  {
    m_bRayTraceEnabled = enabled;
  }
  
  bool rayTraceEnabled() const
  {
    return m_bRayTraceEnabled;
  }
  
  void setRayTraceDepth(int reflection, int refraction, int sum)
  {
    m_iRTReflection = reflection;
    m_iRTRefraction = refraction;
    m_iRTSum = sum;
  }
  
  void rayTraceDepth(int& reflection, int& refraction, int& sum) const
  {
    reflection = m_iRTReflection;
    refraction = m_iRTRefraction;
    sum = m_iRTSum;
  }
  
  void setGlobalIlluminationEnabled(bool enabled)
  {
    m_bGlobalIllum = enabled;
  }
  
  bool globalIlluminationEnabled() const
  {
    return m_bGlobalIllum;
  }
  
  void setGISampleCount(int num)
  {
    m_iGISampleCount = num;
  }
  
  int giSampleCount() const
  {
    return m_iGISampleCount;
  }
  
  void setGISampleRadiusEnabled(bool enabled)
  {
    m_bSampleRadEnabled = enabled;
  }
  
  bool giSampleRadiusEnabled() const
  {
    return m_bSampleRadEnabled;
  }
  
  void setGISampleRadius(double radius)
  {
    m_dSampleRad = radius;
  }
  
  double giSampleRadius() const
  {
    return m_dSampleRad;
  }
  
  void setGIPhotonsPerLight(int num)
  {
    m_iPhotonsPerLight = num;
  }
  
  int giPhotonsPerLight() const
  {
    return m_iPhotonsPerLight;
  }
  
  void setPhotonTraceDepth(int reflection, int refraction, int sum)
  {
    m_iPhotonsReflection = reflection;
    m_iPhotonsRefraction = refraction;
    m_iPhotonsSum = sum;
  }
  
  void photonTraceDepth(int& reflection, int& refraction, int& sum) const
  {
    reflection = m_iPhotonsReflection;
    refraction = m_iPhotonsRefraction;
    sum = m_iPhotonsSum;
  }
  
  void setFinalGatheringEnabled(bool enabled)
  {
    m_bFGEnabled = enabled;
  }
  
  bool finalGatheringEnabled() const
  {
    return m_bFGEnabled;
  }
  
  void setFGRayCount(int num)
  {
    m_iFGRayCount = num;
  }
  
  int fgRayCount() const
  {
    return m_iFGRayCount;
  }
  
  void setFGRadiusState(bool bMin, bool bMax, bool bPixels)
  {
    m_bFGRadMin = bMin;
    m_bFGRadMax = bMax;
    m_bFGPixels = bPixels;
  }
  
  void fgSampleRadiusState(bool& bMin, bool& bMax, bool& bPixels)
  {
    bMin = m_bFGRadMin;
    bMax = m_bFGRadMax;
    bPixels = m_bFGPixels;
  }
  
  void setFGSampleRadius(double min, double max)
  {
    m_dFGSRadMin = min;
    m_dFGSRadMax = max;
  }
  
  void fgSampleRadius(double& min, double& max) const
  {
    min = m_dFGSRadMin;
    max = m_dFGSRadMax;
  }
  
  void setLightLuminanceScale(double luminance)
  {
    m_dLightLumScale = luminance;
  }
  
  double lightLuminanceScale() const
  {
    return m_dLightLumScale;
  }
  
  void setDiagnosticMode(OdGiMrDiagnosticMode mode)
  {
    m_DiagMode = mode;
  }
  
  OdGiMrDiagnosticMode diagnosticMode() const
  {
    return m_DiagMode;
  }
  
  void setDiagnosticGridMode(OdGiMrDiagnosticGridMode mode, float fSize)
  {
    m_DiagGridMode = mode;
    m_fDiagGridSize = fSize;
  }
  
  void diagnosticGridMode(OdGiMrDiagnosticGridMode& mode, float& fSize) const
  {
    mode = m_DiagGridMode;
    fSize = m_fDiagGridSize;
  }
  
  void setDiagnosticPhotonMode(OdGiMrDiagnosticPhotonMode mode)
  {
    m_DiagPhtMode = mode;
  }
  
  OdGiMrDiagnosticPhotonMode diagnosticPhotonMode() const
  {
    return m_DiagPhtMode;
  }
  
  void setDiagnosticBSPMode(OdGiMrDiagnosticBSPMode mode)
  {
    m_DiagBSPMode = mode;
  }
  
  OdGiMrDiagnosticBSPMode diagnosticBSPMode() const
  {
    return m_DiagBSPMode;
  }
  
  void setExportMIEnabled(bool enabled)
  {
    m_bExportMIEnabled = enabled;
  }
  
  bool exportMIEnabled() const
  {
    return m_bExportMIEnabled;
  }
  
  void setExportMIFileName(const OdString& miName)
  {
    m_sMIFile = miName;
  }
  
  const OdString &exportMIFileName() const
  {
    return m_sMIFile;
  }
  
  void setTileSize(int size)
  {
    m_iTileSize = size;
  }
  
  int tileSize() const
  {
    return m_iTileSize;
  }
  
  void setTileOrder(OdGiMrTileOrder order)
  {
    m_TileOrder = order;
  }
  
  OdGiMrTileOrder tileOrder() const
  {
    return m_TileOrder;
  }
  
  void setMemoryLimit(int limit)
  {
    m_iMemLimit = limit;
  }
  
  int memoryLimit() const
  {
    return m_iMemLimit;
  }
  
  void setEnergyMultiplier(float fScale)
  {
    m_fEnergyMult = fScale;
  }
  
  float energyMultiplier() const
  {
    return m_fEnergyMult;
  }
  
  void setProgressMonitor(void* pMonitor)
  {
    m_pProgressMonitor = pMonitor;
  }
  
  const void* progressMonitor() const
  {
    return m_pProgressMonitor;
  }
  
  void setExposureType(OdGiMrExposureType type)
  {
    m_ExposureType = type;
  }
  
  OdGiMrExposureType exposureType() const
  {
    return m_ExposureType;
  }
  
  void setFinalGatheringMode(OdGiMrFinalGatheringMode mode)
  {
    m_FGMode = mode;
  }
  
  OdGiMrFinalGatheringMode finalGatheringMode() const
  {
    return m_FGMode;
  }
  
  void setShadowSamplingMultiplier(double multiplier)
  {
    m_dShadowMult = multiplier;
  }
  
  double shadowSamplingMultiplier() const
  {
    return m_dShadowMult;
  }
  
  void setExportMIMode(OdGiMrExportMIMode mode)
  {
    m_MIMode = mode;
  }
  
  OdGiMrExportMIMode exportMIMode() const
  {
    return m_MIMode;
  }

  bool operator !=(const OdGiMentalRayRenderSettingsTraitsData &data2) const
  {
    return ((*static_cast<const OdGiRenderSettingsTraitsData*>(this) != static_cast<const OdGiRenderSettingsTraitsData&>(data2)) ||
           (m_iSamplingMin != data2.m_iSamplingMin) ||
           (m_iSamplingMax != data2.m_iSamplingMax) ||
           (m_SamplingFilter != data2.m_SamplingFilter) ||
           !OdEqual(m_dSamplingWidth, data2.m_dSamplingWidth) ||
           !OdEqual(m_dSamplingHeight, data2.m_dSamplingHeight) ||
           (m_fContrastR != data2.m_fContrastR) ||
           (m_fContrastG != data2.m_fContrastG) ||
           (m_fContrastB != data2.m_fContrastB) ||
           (m_fContrastA != data2.m_fContrastA) ||
           (m_ShadowMode != data2.m_ShadowMode) ||
           (m_bShadowMapEnabled != data2.m_bShadowMapEnabled) ||
           (m_bRayTraceEnabled != data2.m_bRayTraceEnabled) ||
           (m_iRTReflection != data2.m_iRTReflection) ||
           (m_iRTRefraction != data2.m_iRTRefraction) ||
           (m_iRTSum != data2.m_iRTSum) ||
           (m_bGlobalIllum != data2.m_bGlobalIllum) ||
           (m_iGISampleCount != data2.m_iGISampleCount) ||
           (m_bSampleRadEnabled != data2.m_bSampleRadEnabled) ||
           !OdEqual(m_dSampleRad, data2.m_dSampleRad) ||
           (m_iPhotonsPerLight != data2.m_iPhotonsPerLight) ||
           (m_iPhotonsReflection != data2.m_iPhotonsReflection) ||
           (m_iPhotonsRefraction != data2.m_iPhotonsRefraction) ||
           (m_iPhotonsSum != data2.m_iPhotonsSum) ||
           (m_bFGEnabled != data2.m_bFGEnabled) ||
           (m_iFGRayCount != data2.m_iFGRayCount) ||
           (m_bFGRadMin != data2.m_bFGRadMin) ||
           (m_bFGRadMax != data2.m_bFGRadMax) ||
           (m_bFGPixels != data2.m_bFGPixels) ||
           !OdEqual(m_dFGSRadMin, data2.m_dFGSRadMin) ||
           !OdEqual(m_dFGSRadMax, data2.m_dFGSRadMax) ||
           !OdEqual(m_dLightLumScale, data2.m_dLightLumScale) ||
           (m_DiagMode != data2.m_DiagMode) ||
           (m_DiagGridMode != data2.m_DiagGridMode) ||
           (m_fDiagGridSize != data2.m_fDiagGridSize) ||
           (m_DiagPhtMode != data2.m_DiagPhtMode) ||
           (m_DiagBSPMode != data2.m_DiagBSPMode) ||
           (m_bExportMIEnabled != data2.m_bExportMIEnabled) ||
           (m_sMIFile != data2.m_sMIFile) ||
           (m_iTileSize != data2.m_iTileSize) ||
           (m_TileOrder != data2.m_TileOrder) ||
           (m_iMemLimit != data2.m_iMemLimit) ||
           (m_fEnergyMult != data2.m_fEnergyMult) ||
           (m_pProgressMonitor != data2.m_pProgressMonitor) ||
           (m_ExposureType != data2.m_ExposureType) ||
           (m_FGMode != data2.m_FGMode) ||
           !OdEqual(m_dShadowMult, data2.m_dShadowMult) ||
           (m_MIMode != data2.m_MIMode));
  }
  
  bool operator ==(const OdGiMentalRayRenderSettingsTraitsData &data2) const
  {
    return !(*this != data2);
  }
};

class OdGiRapidRTRenderSettingsTraitsData : public virtual OdGiRenderSettingsTraitsData
{
  OdGiQuitCondition          m_QuitCondition;
  int                        m_iRenderLevel;
  int                        m_iRenderTime;
  OdGiLightingMode           m_LightingModel;
  OdGiFilterType             m_FilterType;
  float                      m_fFilterWidth;
  float                      m_fFilterHeight;
public:
  
  OdGiRapidRTRenderSettingsTraitsData()
    : OdGiRenderSettingsTraitsData()
    , m_QuitCondition(krEQuitByRenderLevel)
    , m_iRenderLevel(1)
    , m_iRenderTime(1)
    , m_LightingModel(krEBasic)
    , m_FilterType(krEBox)
    , m_fFilterWidth(1.0f)
    , m_fFilterHeight(1.0f)
  {
  }

  void setQuitCondition(OdGiQuitCondition condition)
  {
    m_QuitCondition = condition;
  }
  
  OdGiQuitCondition quitCondition() const
  {
    return m_QuitCondition;
  }
  
  void setDesiredRenderLevel(int level)
  {
    m_iRenderLevel = level;
  }
  
  int desiredRenderLevel() const
  {
    return m_iRenderLevel;
  }
  
  void setDesiredRenderTime(int time)
  {
    m_iRenderTime = time;
  }
  
  int desiredRenderTime() const
  {
    return m_iRenderTime;
  }
  
  void setLightingMode(OdGiLightingMode mode)
  {
    m_LightingModel = mode;
  }
  
  OdGiLightingMode lightingMode() const
  {
    return m_LightingModel;
  }
  
  void setFilterType(OdGiFilterType type)
  {
    m_FilterType = type;
  }
  
  OdGiFilterType filterType() const
  {
    return m_FilterType;
  }
  
  void setFilterWidth(float width)
  {
    m_fFilterWidth = width;
  }
  
  float filterWidth() const
  {
    return m_fFilterWidth;
  }
  
  void setFilterHeight(float height)
  {
    m_fFilterHeight = height;
  }
  
  float filterHeight() const
  {
    return m_fFilterHeight;
  }

  bool operator !=(const OdGiRapidRTRenderSettingsTraitsData &data2) const
  {
    return ((*static_cast<const OdGiRenderSettingsTraitsData*>(this) != static_cast<const OdGiRenderSettingsTraitsData&>(data2)) ||
      (m_QuitCondition != data2.m_QuitCondition) ||
      (m_iRenderLevel != data2.m_iRenderLevel) ||
      (m_iRenderTime != data2.m_iRenderTime) ||
      (m_LightingModel != data2.m_LightingModel) ||
      (m_FilterType != data2.m_FilterType) ||
      (m_fFilterWidth != data2.m_fFilterWidth) ||
      (m_fFilterHeight != data2.m_fFilterHeight));
  }
  
  bool operator ==(const OdGiRapidRTRenderSettingsTraitsData &data2) const
  {
    return !(*this != data2);
  }
};

class OdGiCombinedRenderSettingsTraitsData : public OdGiMentalRayRenderSettingsTraitsData
                                           , public OdGiRapidRTRenderSettingsTraitsData
{
  OdUInt32 m_kindOfRenderSettings;
public:
  OdGiCombinedRenderSettingsTraitsData()
    : m_kindOfRenderSettings(0)
  {
  }

  enum KindOfRenderSettings
  {
    kMentalRaySettings = 1,
    kRapidRTSettings   = 2
  };
  
  void setKindOfRenderSettings(OdUInt32 nFlags)
  {
    m_kindOfRenderSettings = nFlags;
  }
  
  OdUInt32 kindOfRenderSettings() const
  {
    return m_kindOfRenderSettings;
  }
  
  void modifyKindOfRenderSettings(OdUInt32 nFlags, bool bOp = true)
  {
    SETBIT(m_kindOfRenderSettings, nFlags, bOp);
  }

  bool hasMentalRayRenderSettings() const
  {
    return GETBIT(m_kindOfRenderSettings, kMentalRaySettings);
  }
  
  bool hasRapidRTRenderSettings() const
  {
    return GETBIT(m_kindOfRenderSettings, kRapidRTSettings);
  }

  bool operator !=(const OdGiCombinedRenderSettingsTraitsData &data2) const
  {
    return ((*static_cast<const OdGiMentalRayRenderSettingsTraitsData*>(this) != static_cast<const OdGiMentalRayRenderSettingsTraitsData&>(data2)) ||
            (*static_cast<const OdGiRapidRTRenderSettingsTraitsData*>(this) != static_cast<const OdGiRapidRTRenderSettingsTraitsData&>(data2)) ||
            (m_kindOfRenderSettings != data2.m_kindOfRenderSettings));
  }
  
  bool operator ==(const OdGiCombinedRenderSettingsTraitsData &data2) const
  {
    return !(*this != data2);
  }
};
 
#include "TD_PackPop.h"
 
#endif // __OD_GI_ENVIRONMENT_TRAITS_DATA__