GiLightTraitsData.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_LIGHT_TRAITS_DATA__
#define __OD_GI_LIGHT_TRAITS_DATA__
 
#include "TD_PackPush.h"
 
#include "Gi/GiLightTraits.h"
#include "Ge/GeMatrix3d.h"
#include "MemoryStream.h"

class OdGiLightTraitsData
{
  double                     m_dIntensity;
  OdCmEntityColor            m_color;
  OdGiShadowParameters       m_shadowParameters;
  OdGeMatrix3d               m_xform;
public:
  enum LightType
  {
    kInvalidLight = -1,
    kPointLight   = OdGiDrawable::kPointLight,
    kSpotLight    = OdGiDrawable::kSpotLight,
    kDistantLight = OdGiDrawable::kDistantLight,
    kWebLight     = OdGiDrawable::kWebLight
  };

  static LightType drawableLightType(const OdGiDrawable *pDrawable);
protected:
  enum LightFlags
  {
    kFlagIsOn          = (1 << 0),
    kFlagIsTransformed = (1 << 1),
    kLastFlag          = kFlagIsTransformed
  };
  OdUInt32  m_uFlags;
  LightType m_type;
 
protected:
  OdGiLightTraitsData()
    : m_dIntensity(0.0)
    , m_uFlags(0)
    , m_type(kInvalidLight)
  {}
 
public:
  bool isOn() const { return GETBIT(m_uFlags, kFlagIsOn); }
  
  void setOn(bool value) { SETBIT(m_uFlags, kFlagIsOn, value); }

  double intensity() const { return m_dIntensity; }
  
  void setIntensity(double dIntensity) { m_dIntensity = dIntensity; }

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

  OdGiShadowParameters shadowParameters() const { return m_shadowParameters; }
  
  void setShadowParameters(const OdGiShadowParameters& params) { m_shadowParameters = params; }

  LightType type() const { return m_type; }

  void save(OdGsFiler * pFiler) const;
  
  void load(OdGsFiler * pFiler);

  static void deleteLightTraitsData(OdGiLightTraitsData* pLightTraits);

  void setLightTransform(const OdGeMatrix3d &xForm)
  { SETBIT(m_uFlags, kFlagIsTransformed, !(m_xform = xForm).isEqualTo(OdGeMatrix3d::kIdentity)); }

  void addLightTransform(const OdGeMatrix3d &xForm)
  { SETBIT(m_uFlags, kFlagIsTransformed, !(m_xform = xForm * m_xform).isEqualTo(OdGeMatrix3d::kIdentity)); }

  void resetLightTransform() { SETBIT_0(m_uFlags, kFlagIsTransformed); m_xform = OdGeMatrix3d::kIdentity; }

  bool isLightTransformed() const { return GETBIT(m_uFlags, kFlagIsTransformed); }

  const OdGeMatrix3d &lightTransformationMatrix() const { return m_xform; }
};
 
inline OdGiLightTraitsData::LightType OdGiLightTraitsData::drawableLightType(const OdGiDrawable *pDrawable)
{
  const LightType lightType = (pDrawable) ? (LightType)pDrawable->drawableType() : kInvalidLight;
  switch (lightType)
  {
    case kPointLight:
    case kSpotLight:
    case kDistantLight:
    case kWebLight:
      return lightType;
    default:
      return kInvalidLight;
  }
}
 
inline void OdGiLightTraitsData::save(OdGsFiler *pFiler) const {
  pFiler->wrBool(isOn());
  pFiler->wrDouble(intensity());
  pFiler->wrUInt32(color().color());
  m_shadowParameters.save(pFiler);
  pFiler->wrBool(isLightTransformed());
  if (isLightTransformed())
    pFiler->wrMatrix3d(lightTransformationMatrix());
}
 
inline void OdGiLightTraitsData::load(OdGsFiler *pFiler) {
  setOn(pFiler->rdBool());
  setIntensity(pFiler->rdDouble());
  { OdCmEntityColor lightColor; lightColor.setColor(pFiler->rdUInt32()); setColor(lightColor); }
  m_shadowParameters.load(pFiler);
  if (pFiler->rdBool())
  { OdGeMatrix3d xForm;
    pFiler->rdMatrix3d(xForm);
    setLightTransform(xForm);
  }
}

class OdGiPointLightTraitsData : public OdGiLightTraitsData
{
  OdGePoint3d          m_position;
  OdGiLightAttenuation m_attenuation;
  // Photometric data
  double               m_dPhysIntensity;
  OdGiColorRGB         m_lampColor;
  OdGePoint3d          m_target;
 
protected:
  enum LightFlags
  {
    kFlagHasTarget  = (OdGiLightTraitsData::kLastFlag << 1),
    kFlagHemisphere = (OdGiLightTraitsData::kLastFlag << 2),
    kLastFlag = kFlagHemisphere
  };
 
public:
  OdGiPointLightTraitsData()
    : m_dPhysIntensity(1500.0)
    , m_lampColor(1.0, 1.0, 1.0)
  {
    m_type = kPointLight;
  }

  OdGePoint3d position() const { return m_position; }
  
  void setPosition(const OdGePoint3d& pos) { m_position = pos; }

  OdGiLightAttenuation attenuation() const { return m_attenuation; }
  
  void setAttenuation(const OdGiLightAttenuation& atten) { m_attenuation = atten; }

  double physicalIntensity() const { return m_dPhysIntensity; }
  
  void setPhysicalIntensity(double intensity) { m_dPhysIntensity = intensity; }

  OdGiColorRGB lampColor() const { return m_lampColor; }
  
  void setLampColor(const OdGiColorRGB& color) { m_lampColor = color; }

  bool hasTarget() const { return GETBIT(m_uFlags, kFlagHasTarget); }
  
  void setHasTarget(bool bTarget) { SETBIT(m_uFlags, kFlagHasTarget, bTarget); }

  OdGePoint3d targetLocation() const { return m_target; }
  
  void setTargetLocation(const OdGePoint3d &loc) { m_target = loc; }

  void setHemisphericalDistribution(bool bHemisphere) { SETBIT(m_uFlags, kFlagHemisphere, bHemisphere); }
  bool hemisphericalDistribution() const { return GETBIT(m_uFlags, kFlagHemisphere); }

  inline void save(OdGsFiler *pFiler) const {
    OdGiLightTraitsData::save(pFiler);
    pFiler->wrPoint3d(position());
    attenuation().save(pFiler);
    pFiler->wrDouble(physicalIntensity());
    pFiler->wrDouble(m_lampColor.red);
    pFiler->wrDouble(m_lampColor.green);
    pFiler->wrDouble(m_lampColor.blue);
    pFiler->wrBool(hasTarget());
    pFiler->wrPoint3d(targetLocation());
    pFiler->wrBool(hemisphericalDistribution());
  }

  inline void load(OdGsFiler *pFiler) {
    OdGiLightTraitsData::load(pFiler);
    pFiler->rdPoint3d(m_position);
    m_attenuation.load(pFiler);
    setPhysicalIntensity(pFiler->rdDouble());
    m_lampColor.red   = pFiler->rdDouble();
    m_lampColor.green = pFiler->rdDouble();
    m_lampColor.blue  = pFiler->rdDouble();
    setHasTarget(pFiler->rdBool());
    pFiler->rdPoint3d(m_target);
    setHemisphericalDistribution(pFiler->rdBool());
  }
};

class OdGiSpotLightTraitsData : public OdGiLightTraitsData
{
  OdGePoint3d          m_position, m_target;
  OdGiLightAttenuation m_attenuation;
  double               m_dHotspot, m_dFalloff;
  // Photometric data
  double               m_dPhysIntensity;
  OdGiColorRGB         m_lampColor;
 
public:
  OdGiSpotLightTraitsData()
    : m_dHotspot(0.0)
    , m_dFalloff(0.0)
    , m_dPhysIntensity(1500.0)
    , m_lampColor(1.0, 1.0, 1.0)
  {
    m_type = kSpotLight;
  }

  OdGePoint3d position() const { return m_position; }
  
  void setPosition(const OdGePoint3d& pos) { m_position = pos; }

  OdGePoint3d target() const { return m_target; }
  
  void setTarget(const OdGePoint3d& trg) { m_target = trg; }

  OdGiLightAttenuation attenuation() const { return m_attenuation; }
  
  void setAttenuation(const OdGiLightAttenuation& atten) { m_attenuation = atten; }

  bool setHotspotAndFalloff(double hotSpot, double falloff);
  
  double hotspot() const { return m_dHotspot; }
  
  double falloff() const { return m_dFalloff; }

  double physicalIntensity() const { return m_dPhysIntensity; }
  
  void setPhysicalIntensity(double intensity) { m_dPhysIntensity = intensity; }

  OdGiColorRGB lampColor() const { return m_lampColor; }
  
  void setLampColor(const OdGiColorRGB& color) { m_lampColor = color; }

  void save(OdGsFiler *pFiler) const {
    OdGiLightTraitsData::save(pFiler);
    pFiler->wrPoint3d(position());
    pFiler->wrPoint3d(target());
    attenuation().save(pFiler);
    pFiler->wrDouble(physicalIntensity());
    pFiler->wrDouble(hotspot());
    pFiler->wrDouble(falloff());
    pFiler->wrDouble(m_lampColor.red);
    pFiler->wrDouble(m_lampColor.green);
    pFiler->wrDouble(m_lampColor.blue);
  }

  void load(OdGsFiler *pFiler) {
    OdGiLightTraitsData::load(pFiler);
    pFiler->rdPoint3d(m_position);
    pFiler->rdPoint3d(m_target);
    m_attenuation.load(pFiler);
    setPhysicalIntensity(pFiler->rdDouble());
    m_dHotspot        = pFiler->rdDouble();
    m_dFalloff        = pFiler->rdDouble();
    m_lampColor.red   = pFiler->rdDouble();
    m_lampColor.green = pFiler->rdDouble();
    m_lampColor.blue  = pFiler->rdDouble();
  }
};

inline bool OdGiSpotLightTraitsData::setHotspotAndFalloff(double hotspot, double falloff)
{ 
  if((hotspot > falloff) || 
     (hotspot < 0.0) || (falloff < 0.0) || 
     (OdaToDegree(hotspot) > 160.0) || (OdaToDegree(falloff) > 160.0))
    return false;
  m_dHotspot = hotspot;
  m_dFalloff = falloff; 
  return true;
}

class OdGiDistantLightTraitsData : public OdGiLightTraitsData
{
  OdGeVector3d m_direction;
  // Photometric data
  double       m_dPhysIntensity;
  OdGiColorRGB m_lampColor;
  //OdGiSkyParameters m_skyParams; // Unused
 
protected:
  enum LightFlags
  {
    kFlagIsSunlight = (OdGiLightTraitsData::kLastFlag << 1),
    kLastFlag = kFlagIsSunlight
  };
 
public:
  OdGiDistantLightTraitsData()
    : m_dPhysIntensity(1500.0)
    , m_lampColor(1.0, 1.0, 1.0)
  {
    m_type = kDistantLight;
  }

  OdGeVector3d direction() const { return m_direction; }
  
  void setDirection(const OdGeVector3d& dir) { m_direction = dir; }

  bool isSunlight() const { return GETBIT(m_uFlags, kFlagIsSunlight); }
  
  void setSunlight(bool val) { SETBIT(m_uFlags, kFlagIsSunlight, val); }

  double physicalIntensity() const { return m_dPhysIntensity; }
  
  void setPhysicalIntensity(double intensity) { m_dPhysIntensity = intensity; }

  OdGiColorRGB lampColor() const { return m_lampColor; }
  
  void setLampColor(const OdGiColorRGB& color) { m_lampColor = color; }

  void skyParameters(OdGiSkyParameters & /*params*/) const { /*params = m_skyParams;*/ }
  
  void setSkyParameters(const OdGiSkyParameters & /*params*/) { /*m_skyParams = params;*/ }

  void save(OdGsFiler *pFiler) const {
    OdGiLightTraitsData::save(pFiler);
    pFiler->wrVector3d(direction());
    pFiler->wrBool(isSunlight());
    pFiler->wrDouble(physicalIntensity());
    pFiler->wrDouble(m_lampColor.red);
    pFiler->wrDouble(m_lampColor.green);
    pFiler->wrDouble(m_lampColor.blue);
  }

  void load(OdGsFiler *pFiler) {
    OdGiLightTraitsData::load(pFiler);
    pFiler->rdVector3d(m_direction);
    setSunlight(pFiler->rdBool());
    setPhysicalIntensity(pFiler->rdDouble());
    m_lampColor.red   = pFiler->rdDouble();
    m_lampColor.green = pFiler->rdDouble();
    m_lampColor.blue  = pFiler->rdDouble();
  }
};

class OdGiWebLightTraitsData : public OdGiPointLightTraitsData
{
  OdString                        m_webFile;
  OdStreamBufPtr                  m_pWebStream;
  OdGeVector3d                    m_webRotate;
  double                          m_dFlux;
  OdGiWebLightTraits::WebFileType m_webFileType;
  OdGiWebLightTraits::WebSymmetry m_webSymmetry;
 
protected:
  enum LightFlags
  {
    kFlagHorzAng90to270 = (OdGiPointLightTraitsData::kLastFlag << 1),
    kLastFlag = kFlagHorzAng90to270
  };
 
public:
  OdGiWebLightTraitsData()
    : OdGiPointLightTraitsData()
    , m_dFlux(0.0)
    , m_webFileType(OdGiWebLightTraits::kTypeA)
    , m_webSymmetry(OdGiWebLightTraits::kNoSymmetry)
  {
    m_type = kWebLight;
  }

  const OdString &webFile() const { return m_webFile; }
  
  void setWebFile(const OdString &fileName) { m_webFile = fileName; }

  virtual void setWebFileStream(OdStreamBufPtr& pWebStream) 
  { 
    if (!m_pWebStream.isNull())
      m_pWebStream.release();
    m_pWebStream = pWebStream; 
  };

  virtual OdStreamBufPtr webFileStream() const { return m_pWebStream; };
 
  
  const OdGeVector3d& webRotation() const { return m_webRotate; }
  
  void setWebRotation(const OdGeVector3d& rot) { m_webRotate = rot; }
 
  
  double webFlux() const { return m_dFlux; }
  
  void setWebFlux(double flux) { m_dFlux = flux; }
 
  
  OdGiWebLightTraits::WebFileType webFileType() const { return m_webFileType; }
  
  void setWebFileType(OdGiWebLightTraits::WebFileType type) { m_webFileType = type; }
 
  
  OdGiWebLightTraits::WebSymmetry webSymmetry() const { return m_webSymmetry; }
  
  void setWebSymmetry(OdGiWebLightTraits::WebSymmetry sym) { m_webSymmetry = sym; }

  bool webHorzAng90to270() const { return GETBIT(m_uFlags, kFlagHorzAng90to270); }
  
  void setWebHorzAng90to270(bool bHA) { SETBIT(m_uFlags, kFlagHorzAng90to270, bHA); }

  inline void save(OdGsFiler *pFiler) const {
    OdGiPointLightTraitsData::save(pFiler);
    pFiler->wrString(webFile());
    pFiler->wrVector3d(webRotation());
    pFiler->wrDouble(webFlux());
    pFiler->wrUInt8((OdUInt8)webFileType());
    pFiler->wrUInt8((OdUInt8)webSymmetry());
    pFiler->wrBool(webHorzAng90to270());
    OdStreamBufPtr pWebFileStream = webFileStream();
    if (pWebFileStream.isNull())
    {
      pFiler->wrBool(false);
    }
    else
    {
      pFiler->wrBool(true);
      pWebFileStream->rewind();
      OdUInt32 dataLength = (OdUInt32)pWebFileStream->length();
      OdBinaryData data;
      data.resize(dataLength);
      pWebFileStream->getBytes(data.asArrayPtr(), dataLength);
      pFiler->wrInt64((OdInt64)dataLength);
      pFiler->wrRawData(data.asArrayPtr(), dataLength);
    }
  }

  inline void load(OdGsFiler *pFiler) {
    OdGiPointLightTraitsData::load(pFiler);
    pFiler->rdString(m_webFile);
    pFiler->rdVector3d(m_webRotate);
    setWebFlux(pFiler->rdDouble());
    setWebFileType((OdGiWebLightTraits::WebFileType)pFiler->rdUInt8());
    setWebSymmetry((OdGiWebLightTraits::WebSymmetry)pFiler->rdUInt8());
    setWebHorzAng90to270(pFiler->rdBool());
    if (pFiler->rdBool())
    {
      OdUInt32 dataLength = (OdUInt32)pFiler->rdInt64();
      OdBinaryData data;
      data.resize(dataLength);
      pFiler->rdRawData(data.asArrayPtr(), dataLength);
      OdStreamBufPtr pWebStream = OdMemoryStream::createNew(dataLength);
      pWebStream->putBytes(data.asArrayPtr(), dataLength);
      setWebFileStream(pWebStream);
    }
  }
};
 
inline void OdGiLightTraitsData::deleteLightTraitsData(OdGiLightTraitsData* pLightTraits)
{
  switch(pLightTraits->type())
  {
  case OdGiLightTraitsData::kDistantLight:
    delete static_cast<OdGiDistantLightTraitsData*>(pLightTraits);
    break;
  case OdGiLightTraitsData::kPointLight:
    delete static_cast<OdGiPointLightTraitsData*>(pLightTraits);
    break;
  case OdGiLightTraitsData::kSpotLight:
    delete static_cast<OdGiSpotLightTraitsData*>(pLightTraits);
    break;
  case OdGiLightTraitsData::kWebLight:
    delete static_cast<OdGiWebLightTraitsData*>(pLightTraits);
    break;
  default:
    {
      ODA_FAIL_ONCE();
    }
    break;
  }
}

class OdGiLightTraitsVpDepData : public OdGiLightTraitsData
{
  OdUInt32    m_nViewportId;
  OdDbStub*   m_pViewportObjectId;
  bool        m_bVpDepOn;
  double      m_dVpDepDimming;
 
public:
  
  OdGiLightTraitsVpDepData() : OdGiLightTraitsData(),
    m_nViewportId( 0 ),
    m_pViewportObjectId( NULL ),
    m_bVpDepOn( false ),
    m_dVpDepDimming( 0.0 )
  {
  }
  
  OdUInt32 viewportId() const { return m_nViewportId; }
  
  void setViewportId( OdUInt32 id ) { m_nViewportId = id; }
 
  
  OdDbStub* viewportObjectId() const { return m_pViewportObjectId; }
  
  void setViewportObjectId( OdDbStub* id ) { m_pViewportObjectId = id; }
 

  bool vpDepOn() const { return m_bVpDepOn; }
  
  void setVpDepOn( bool on ) { m_bVpDepOn = on; }
 
  double vpDepDimming() const { return m_dVpDepDimming; }
  void setVpDepDimming( double dimming ) { m_dVpDepDimming = dimming; }

  inline void save(OdGsFiler *pFiler) const {
    OdGiLightTraitsData::save(pFiler);
    pFiler->wrBool( vpDepOn() );
    pFiler->wrDouble( vpDepDimming() );
    pFiler->wrUInt32( viewportId() );
    pFiler->wrHandle( viewportObjectId() );
  }

  inline void load(OdGsFiler *pFiler) {
    OdGiLightTraitsData::load(pFiler);
    setVpDepOn( pFiler->rdBool() );
    setVpDepDimming( pFiler->rdDouble() );
    setViewportId( pFiler->rdUInt32() );
    setViewportObjectId( pFiler->rdHandle() );
  }
};
 
template <class LightTraitsDataType>
inline void transformLightTraitsDataPosition(LightTraitsDataType &traitsData, const OdGeMatrix3d &modelTransform)
{
  OdGePoint3d newPos(traitsData.position());
  newPos.transformBy(modelTransform);
  traitsData.setPosition(newPos);
  traitsData.addLightTransform(modelTransform);
}
// For Point and Web lights
template <class LightTraitsDataType>
inline void transformLightTraitsData(LightTraitsDataType &traitsData, const OdGeMatrix3d &modelTransform)
{
  transformLightTraitsDataPosition(traitsData, modelTransform);
  if (traitsData.hasTarget())
  {
    OdGePoint3d newTarget = traitsData.targetLocation();
    newTarget.transformBy(modelTransform);
    traitsData.setTargetLocation(newTarget);
  }
}
// Specialization for Spot lights
template <>
inline void transformLightTraitsData<OdGiSpotLightTraitsData>(OdGiSpotLightTraitsData &traitsData, const OdGeMatrix3d &modelTransform)
{
  transformLightTraitsDataPosition(traitsData, modelTransform);
  OdGePoint3d newTarget = traitsData.target();
  newTarget.transformBy(modelTransform);
  traitsData.setTarget(newTarget);
}
// Specialization for Direction lights
template <>
inline void transformLightTraitsData<OdGiDistantLightTraitsData>(OdGiDistantLightTraitsData &traitsData, const OdGeMatrix3d &modelTransform)
{
  OdGeVector3d newDirection = traitsData.direction();
  newDirection.transformBy(modelTransform);
  traitsData.setDirection(newDirection);
  traitsData.addLightTransform(modelTransform);
}
 
#include "TD_PackPop.h"
 
#endif // __OD_GI_LIGHT_TRAITS_DATA__