GiViewportTraits.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_VIEWPORT_TRAITS__
#define __OD_GI_VIEWPORT_TRAITS__
 
#include "TD_PackPush.h"
 
#include "Gi.h"
#include "CmColorBase.h"
#include "StaticRxObject.h"
 
class OdGiShadowParameters;

class FIRSTDLL_EXPORT OdGiToneOperatorParameters : public OdRxObject
{
public:
  enum ExteriorDaylightMode
  {
    kDaylightOff  = 0,
    kDaylightOn   = 1,
    kDaylightAuto = 2
  };
public:
  ODRX_DECLARE_MEMBERS(OdGiToneOperatorParameters);

  OdGiToneOperatorParameters();
  
  OdGiToneOperatorParameters(const OdGiToneOperatorParameters &params);
  
  virtual ~OdGiToneOperatorParameters() { }

  bool operator ==(const OdGiToneOperatorParameters &params) const;
  
  bool operator !=(const OdGiToneOperatorParameters &params) const;
  
  OdGiToneOperatorParameters &operator =(const OdGiToneOperatorParameters &params);

  virtual void setIsActive(bool bActive);
  
  virtual bool isActive() const;
 
  
  virtual void setChromaticAdaptation(bool bEnable);
  
  virtual bool chromaticAdaptation() const;
 
  
  virtual void setColorDifferentiation(bool bEnable);
  
  virtual bool colorDifferentiation() const;

  virtual void setWhiteColor(const OdCmEntityColor &color);
  
  virtual const OdCmEntityColor &whiteColor() const;
 
  
  virtual void setProcessBackground(bool bProcessBg);
  
  virtual bool processBackground() const;
 
  
  virtual bool setBrightness(double fBrightness);
  
  virtual double brightness() const;
 
  
  virtual bool setContrast(double fContrast);
  
  virtual double contrast() const;
 
  
  virtual bool setMidTones(double fMidTones);
  
  virtual double midTones() const;
 
  
  virtual bool setExteriorDaylight(ExteriorDaylightMode mode);
  
  virtual ExteriorDaylightMode exteriorDaylight() const;
private:
  bool m_bIsActive;
  bool m_bChromaticAdaptation;
  bool m_bColorDifferentiation;
  OdCmEntityColor m_clrWhiteColor;
  bool m_bProcessBackground;
  double m_fBrightness;
  double m_fContrast;
  double m_fMidTones;
  ExteriorDaylightMode m_eExteriorDaylight;
};

class OdGiToneOperatorParametersStatic : public OdStaticRxObject<OdGiToneOperatorParameters>
{
  public:
    OdGiToneOperatorParametersStatic() : OdStaticRxObject<OdGiToneOperatorParameters>() { }
    bool operator ==(const OdGiToneOperatorParameters &params) const { return params.operator ==(*this); }
    
    bool operator !=(const OdGiToneOperatorParameters &params) const { return params.operator !=(*this); }
    
    OdGiToneOperatorParameters &operator =(const OdGiToneOperatorParameters &params) { return (static_cast<OdGiToneOperatorParameters&>(*this) = params); }
};

typedef OdSmartPtr<OdGiToneOperatorParameters> OdGiToneOperatorParametersPtr;

class FIRSTDLL_EXPORT OdGiPhotographicExposureParameters : public OdGiToneOperatorParameters
{
public:
  ODRX_DECLARE_MEMBERS(OdGiPhotographicExposureParameters);

  OdGiPhotographicExposureParameters();
  
  OdGiPhotographicExposureParameters(const OdGiPhotographicExposureParameters &params);
  
  virtual ~OdGiPhotographicExposureParameters() { }

  bool operator ==(const OdGiPhotographicExposureParameters &params) const;
  
  bool operator !=(const OdGiPhotographicExposureParameters &params) const;
  
  OdGiPhotographicExposureParameters &operator =(const OdGiPhotographicExposureParameters &params);
 
  
  virtual bool setExposure(double fExposure);
  
  virtual double exposure() const;
 
  
  virtual bool setWhitePoint(double fWhitePoint);
  
  virtual double whitePoint() const;

  virtual bool setBrightness(double fBrightness);

  OdCmEntityColor whitePointToColor() const;

  static double convertExposureToBrightness(double fExposure);
  
  static double convertBrightnessToExposure(double fBrightness);
private:
  double m_fExposure;
  double m_fWhitePoint;
};

class OdGiPhotographicExposureParametersStatic : public OdStaticRxObject<OdGiPhotographicExposureParameters>
{
public:
  OdGiPhotographicExposureParametersStatic() : OdStaticRxObject<OdGiPhotographicExposureParameters>() { }
  bool operator ==(const OdGiPhotographicExposureParameters &params) const { return params.operator ==(*this); }
  
  bool operator !=(const OdGiPhotographicExposureParameters &params) const { return params.operator !=(*this); }
  
  OdGiPhotographicExposureParameters &operator =(const OdGiPhotographicExposureParameters &params) { return (static_cast<OdGiPhotographicExposureParameters&>(*this) = params); }
};

typedef OdSmartPtr<OdGiPhotographicExposureParameters> OdGiPhotographicExposureParametersPtr;

class FIRSTDLL_EXPORT OdGiViewportTraits : public OdGiSubEntityTraits
{
public:
  ODRX_DECLARE_MEMBERS(OdGiViewportTraits);

  enum DefaultLightingType 
  {
    kOneDistantLight  = 0,
    kTwoDistantLights = 1,
    kBackLighting     = 2,
    kUserDefinedLight = 3
  };
 
  
  virtual bool isDefaultLightingOn() const = 0;
  virtual void setDefaultLightingOn(bool b) = 0;
 
  
  virtual DefaultLightingType defaultLightingType() const = 0;
  virtual void setDefaultLightingType(DefaultLightingType) = 0;
 
  
  virtual OdGeVector3d userDefinedLightDirection() const = 0;
  virtual void setUserDefinedLightDirection(const OdGeVector3d& lightDirection) = 0;
 
  
  virtual double defaultLightingIntensity() const = 0;
  virtual void setDefaultLightingIntensity(double dIntensity) = 0;
 
  
  virtual OdCmEntityColor defaultLightingColor() const = 0;
  virtual void setDefaultLightingColor(const OdCmEntityColor& color) = 0;
 
  
  virtual void defaultLightingShadowParameters(OdGiShadowParameters &params) const = 0;
  virtual void setDefaultLightingShadowParameters(const OdGiShadowParameters &params) = 0;
 
  
  virtual void setAmbientLightColor(const OdCmEntityColor& color) = 0;
  virtual OdCmEntityColor ambientLightColor() const = 0;
 
  
  virtual void setContrast(double contrast) = 0;
  virtual double contrast() const = 0;
 
  
  virtual void setBrightness(double brightness) = 0;
  virtual double brightness() const = 0;
 
  
  virtual void setBackground(OdDbStub* bg) = 0;
  virtual OdDbStub* background() const = 0;
 
  
  virtual void setRenderEnvironment(OdDbStub* re) = 0;
  virtual OdDbStub* renderEnvironment () const = 0;
 
  
  virtual void setRenderSettings(OdDbStub* rs) = 0;
  virtual OdDbStub* renderSettings() const = 0;
 
  
  virtual void setToneOperatorParameters(const OdGiToneOperatorParameters &params) = 0;
  virtual void toneOperatorParameters(OdGiToneOperatorParameters &params) = 0;
};

typedef OdSmartPtr<OdGiViewportTraits> OdGiViewportTraitsPtr;
 
#include "TD_PackPop.h"
 
#endif // __OD_GI_VIEWPORT_TRAITS__