DbRenderSettings.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 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 _DbRenderSettings_h_Included_
#define _DbRenderSettings_h_Included_
 
#include "Gi/GiEnvironment.h"
 
class TOOLKIT_EXPORT OdDbRenderSettings : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbRenderSettings);
 
  OdDbRenderSettings();
  virtual ~OdDbRenderSettings();
 
  virtual OdGiDrawable* drawable();
 
  OdResult setName(const OdString& name);
 
  OdString name() const;
 
  void setDescription(const OdString& description);
 
  OdString description() const;
 
  void setDisplayIndex(int displayIndex);
 
  int displayIndex() const;
 
  
  void setMaterialsEnabled(bool materialsEnabled);
 
  bool materialsEnabled() const;
 
  void setTextureSampling(bool textureSampling);
 
  bool textureSampling() const;
 
  void setBackFacesEnabled(bool backFacesEnabled);
 
  bool backFacesEnabled() const;
 
  void setShadowsEnabled(bool shadowsEnabled);
 
  bool shadowsEnabled() const;
 
 
  OdResult setPreviewImageFileName(const OdString& filename);
 
  OdString previewImageFileName() const;
 
  void setDiagnosticBackgroundEnabled(bool diagnosticBackgroundEnabled);
 
  bool diagnosticBackgroundEnabled() const;
 
  OdResult setIsPredefined(bool bSet);
 
  bool isPredefined() const;
 
  // OdDbObject functions
 
  virtual OdResult dwgInFields(OdDbDwgFiler* pFiler);
  virtual void dwgOutFields(OdDbDwgFiler* pFiler) const;
  virtual OdResult dxfInFields(OdDbDxfFiler* pFiler);
  virtual void dxfOutFields(OdDbDxfFiler* pFiler) const;
 
  // OdGiDrawable functions
 
  virtual OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits)const;
 
  virtual bool operator==(const OdDbRenderSettings& settings);
};
 
typedef OdSmartPtr<OdDbRenderSettings> OdDbRenderSettingsPtr;
 
 
class TOOLKIT_EXPORT OdDbMentalRayRenderSettings : public OdDbRenderSettings
{
public:
  enum ShadowSamplingMultiplier
  {
    kSamplingMultiplierZero         = 0, // 0
    kSamplingMultiplierOneEighth    = 1, // 1/8
    kSamplingMultiplierOneFourth    = 2, // 1/4
    kSamplingMultiplierOneHalf      = 3, // 1/2
    kSamplingMultiplierOne          = 4, // 1
    kSamplingMultiplierTwo          = 5  // 2
  };
public:
  ODDB_DECLARE_MEMBERS(OdDbMentalRayRenderSettings);
 
  OdDbMentalRayRenderSettings();
 
  virtual ~OdDbMentalRayRenderSettings();
 
  OdResult setSampling(int min, int max);
 
  void sampling(int& min, int& max) const;
 
  OdResult setSamplingFilter(OdGiMrFilter filter, double width,
    double height);
 
  void SamplingFilter(OdGiMrFilter& filter, double& width, double& height)
    const;
 
  OdResult setSamplingContrastColor(float red, float green, float blue, float alpha);
 
  void samplingContrastColor(float& red, float& green, float& blue, float& alpha) const;
 
  void setShadowMode(OdGiMrShadowMode shadowMode);
 
  OdGiMrShadowMode shadowMode() const;
 
  void setShadowMapsEnabled(bool shadowMapsEnabled);
 
  bool shadowMapsEnabled() const;
 
  void setRayTracingEnabled(bool rayTracingEnabled);
 
  bool rayTracingEnabled() const;
 
  OdResult setRayTraceDepth(int reflection, int refraction,
    int sum);
 
  void rayTraceDepth(int& reflection, int& refraction, int& sum) const;
 
  void setGlobalIlluminationEnabled(bool globalIlluminationEnabled);
 
  bool globalIlluminationEnabled() const;
 
  OdResult setGISampleCount(int numPhotons);
 
  int giSampleCount() const;
 
  void setGISampleRadiusEnabled(bool giSampleRadiusEnabled);
 
  bool giSampleRadiusEnabled() const;
 
  OdResult setGISampleRadius(double radius);
 
  double giSampleRadius() const;
 
  OdResult setGIPhotonsPerLight(int numPhotons);
 
  int giPhotonsPerLight() const;
 
  OdResult setPhotonTraceDepth(int reflection, int refraction,
    int sum);
 
  void photonTraceDepth(int& reflection, int& refraction, int& sum) const;
 
  void setFinalGatheringEnabled(bool finalGatheringEnabled);
 
  bool finalGatheringEnabled() const;
 
  OdResult setFGRayCount(int fgRayCount);
 
  int fgRayCount() const;
 
  void setFGRadiusState(bool useMin, bool useMax, bool inPixels);
 
  void fgSampleRadiusState(bool& useMin, bool& useMax, bool& inPixels) const;
 
  OdResult setFGSampleRadius(double minRadius, double maxRadius);
 
  void fgSampleRadius(double& minRadius, double& maxRadius) const;
 
  OdResult setEnergyMultiplier(float energyMultiplier);
 
  float energyMultiplier() const;
 
  void setDiagnosticMode(OdGiMrDiagnosticMode diagnosticMode);
 
  OdGiMrDiagnosticMode diagnosticMode() const;
 
  OdResult setDiagnosticGridMode(
    OdGiMrDiagnosticGridMode diagnosticGridMode, float gridSpace);
 
  void diagnosticGridMode(
    OdGiMrDiagnosticGridMode& diagnosticGridMode, float& gridSpace) const;
 
  void setDiagnosticPhotonMode(
    OdGiMrDiagnosticPhotonMode diagnosticPhotonMode);
 
  OdGiMrDiagnosticPhotonMode diagnosticPhotonMode() const;
 
  void setDiagnosticSamplesMode(bool diagnosticSamplesMode);
 
  bool diagnosticSamplesMode() const;
 
  void setDiagnosticBSPMode(OdGiMrDiagnosticBSPMode diagnosticBSPMode);
 
  OdGiMrDiagnosticBSPMode diagnosticBSPMode() const;
 
  void setExportMIEnabled(bool exportMIEnabled);
 
  bool exportMIEnabled() const;
 
  OdResult setExportMIFileName(const OdString& filename);
 
  OdString exportMIFileName() const;
 
  OdResult setTileSize(int tileSize);
 
  int tileSize() const;
 
  void setTileOrder(OdGiMrTileOrder tileOrder);
 
  OdGiMrTileOrder tileOrder() const;
 
 
  OdResult setMemoryLimit(int memoryLimit);
 
  int memoryLimit() const;
 
  OdResult setFinalGatheringMode(OdGiMrFinalGatheringMode mode);
 
  OdGiMrFinalGatheringMode finalGatheringMode() const;
 
  OdResult setLightLuminanceScale(double fLuminance);
 
  double lightLuminanceScale() const;
 
  OdResult setExportMIMode(OdGiMrExportMIMode eExportMIMode);
 
  OdGiMrExportMIMode exportMIMode() const;
 
  OdResult setShadowSamplingMultiplier(ShadowSamplingMultiplier multiplier);
 
  ShadowSamplingMultiplier shadowSamplingMultiplier() const;
 
  // OdDbObject functions
  
  virtual OdResult dwgInFields(OdDbDwgFiler* pFiler);
  virtual void dwgOutFields(OdDbDwgFiler* pFiler) const;
  virtual OdResult dxfInFields(OdDbDxfFiler* pFiler);
  virtual void dxfOutFields(OdDbDxfFiler* pFiler) const;
 
  // OdGiDrawable functions
  
  virtual OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits) const;
 
  virtual bool operator==(const OdDbMentalRayRenderSettings& settings);
};
 
typedef OdSmartPtr<OdDbMentalRayRenderSettings> OdDbMentalRayRenderSettingsPtr;
 
 
class TOOLKIT_EXPORT OdDbRapidRTRenderSettings : public OdDbRenderSettings
{
public:
  enum RenderTarget
  {
    krLevel = 0, // Quit by level
    krTime,      // Quit by time
    krInfinite   // Quit never
  };
public:
  ODDB_DECLARE_MEMBERS(OdDbRapidRTRenderSettings);
 
  OdDbRapidRTRenderSettings();
 
  virtual ~OdDbRapidRTRenderSettings();
 
  OdResult setRenderTarget(RenderTarget target);
 
  RenderTarget renderTarget() const;
 
  OdResult setRenderLevel(int level);
 
  int renderLevel() const;
 
  OdResult setRenderTime(int time);
 
  int renderTime() const;
 
  OdResult setLightingModel(OdGiLightingMode mode);
 
  OdGiLightingMode lightingModel() const;
 
  OdResult setFilterType(OdGiFilterType type);
 
  OdGiFilterType filterType() const;
 
  OdResult setFilterWidth(float width);
 
  float filterWidth() const;
 
  OdResult setFilterHeight(float height);
 
  float filterHeight() const;
 
  OdResult setFilterDimensions(float width, float height)
  {
    OdResult result = setFilterWidth(width);
    if (result == eOk)
      result = setFilterHeight(height);
    return result;
  }
 
  void filterDimensions(float &width, float &height) const
  {
    width = filterWidth();
    height = filterHeight();
  }
 
  // OdDbObject functions
 
  virtual OdResult dwgInFields(OdDbDwgFiler* pFiler);
  virtual void dwgOutFields(OdDbDwgFiler* pFiler) const;
  virtual OdResult dxfInFields(OdDbDxfFiler* pFiler);
  virtual void dxfOutFields(OdDbDxfFiler* pFiler) const;
 
  // OdGiDrawable functions
 
  virtual OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits) const;
 
  virtual bool operator==(const OdDbRapidRTRenderSettings& settings);
};
 
typedef OdSmartPtr<OdDbRapidRTRenderSettings> OdDbRapidRTRenderSettingsPtr;
 
 
class TOOLKIT_EXPORT OdDbRenderEnvironment : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbRenderEnvironment);
 
  OdDbRenderEnvironment();
  virtual ~OdDbRenderEnvironment();
 
  void setFogEnabled(bool bEnable);
 
  bool fogEnabled() const;
 
  void setFogBackgroundEnabled(bool bEnable);
 
  bool fogBackgroundEnabled() const;
 
  void setFogColor(const OdCmEntityColor& color);
 
  OdCmEntityColor fogColor() const;
 
  OdResult setFogDensity(double dNear, double dFar);
 
  void fogDensity(double& dNear, double& dFar) const;
 
  OdResult setDistances(double dNear, double dFar);
 
  void distances(double& dNear, double& dFar) const;
 
  void setEnvironmentImageEnabled(bool bEnabled);
 
  bool environmentImageEnabled() const;
 
  OdResult setEnvironmentImageFileName(const OdString& sFileName);
 
  OdString environmentImageFileName() const;
 
  // OdDbObject functions
 
  OdGiDrawable* drawable();
  OdResult dwgInFields(OdDbDwgFiler* pFiler);
  void dwgOutFields(OdDbDwgFiler* pFiler) const;
  OdResult dxfInFields(OdDbDxfFiler* pFiler);
  void dxfOutFields(OdDbDxfFiler* pFiler) const;
 
  // OdGiDrawable functions
 
  OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits)const;
};
 
typedef OdSmartPtr<OdDbRenderEnvironment> OdDbRenderEnvironmentPtr;
 
 
class TOOLKIT_EXPORT OdDbRenderGlobal : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbRenderGlobal);
 
  enum Procedure
  {
    krView = 0,
    krCrop,
    krSelected
  };
 
  enum Destination
  {
    krWindow = 0,
    krViewport
  };
 
  OdDbRenderGlobal();
  virtual ~OdDbRenderGlobal();
 
  void setProcedureAndDestination(Procedure nProcedure, Destination nDestination);
 
  void procedureAndDestination(Procedure& nProcedure, Destination& nDestination) const;
 
  OdResult setProcedure(Procedure nProcedure);
 
  Procedure procedure();
 
  OdResult setDestination(Destination nDestination);
 
  Destination destination();
 
  void setSaveEnabled(bool bEnabled);
 
  bool saveEnabled() const;
 
  OdResult setSaveFileName(const OdString& sFileName);
 
  OdString saveFileName() const;
 
  OdResult setDimensions(int w, int h);
 
  void dimensions(int& w, int& h) const;
 
  void setPredefinedPresetsFirst(bool bPredefinedPresetsFirst);
 
  bool predefinedPresetsFirst() const;
 
  void setHighInfoLevel(bool bHighInfoLevel);
 
  bool highInfoLevel() const;
 
  OdResult setExposureType(OdGiMrExposureType type);
 
  OdGiMrExposureType exposureType() const;
 
  OdString dimensionName() const;
 
  // OdDbObject functions
 
  OdResult dwgInFields(OdDbDwgFiler* pFiler);
  void dwgOutFields(OdDbDwgFiler* pFiler) const;
  OdResult dxfInFields(OdDbDxfFiler* pFiler);
  void dxfOutFields(OdDbDxfFiler* pFiler) const;
};
 
typedef OdSmartPtr<OdDbRenderGlobal> OdDbRenderGlobalPtr;
 
 
class TOOLKIT_EXPORT OdDbRenderEntry : public OdDbObject
{
public:
  ODDB_DECLARE_MEMBERS(OdDbRenderEntry);
 
  OdDbRenderEntry();
  virtual ~OdDbRenderEntry();
 
  OdResult setImageFileName(const OdString &fileName);
  OdString imageFileName() const;
 
  void setDisplayIndex(int nDisplay);
  int displayIndex() const;
 
  OdResult setPresetName(const OdString &name);
  OdString presetName() const;
 
  OdResult setViewName(const OdString &name);
  OdString viewName() const;
 
  OdResult setDimensions(int w, int h);
  void dimensions(int &w, int &h) const;
  int dimensionW() const { int w, h; dimensions(w, h); return w; }
  int dimensionH() const { int w, h; dimensions(w, h); return h; }
 
  OdResult setStartTime(const OdDbDate &date);
  const OdDbDate &startTime() const;
 
  OdResult setEndTime(const OdDbDate &date);
  const OdDbDate &endTime() const;
 
  void setRenderTime(float fTime);
  float renderTime() const;
 
  void setMemoryAmount(int nAmount);
  int memoryAmount() const;
 
  void setMaterialCount(int nCount);
  int materialCount() const;
 
  void setLightCount(int nCount);
  int lightCount() const;
 
  void setTriangleCount(int nCount);
  int triangleCount() const;
 
  // OdDbObject functions
 
  OdResult dwgInFields(OdDbDwgFiler* pFiler);
  void dwgOutFields(OdDbDwgFiler* pFiler) const;
  OdResult dxfInFields(OdDbDxfFiler* pFiler);
  void dxfOutFields(OdDbDxfFiler* pFiler) const;
};
 
typedef OdSmartPtr<OdDbRenderEntry> OdDbRenderEntryPtr;
 
 
TOOLKIT_EXPORT OdDbObjectId oddbGetRenderSettingsDictionaryId(OdDbDatabase* pDb, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbDictionaryPtr oddbGetRenderSettingsDictionary(OdDbDatabase* pDb, OdDb::OpenMode mode, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbObjectId oddbGetRenderPlotSettingsDictionaryId(OdDbDatabase* pDb, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbDictionaryPtr oddbGetRenderPlotSettingsDictionary(OdDbDatabase* pDb, OdDb::OpenMode mode, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbObjectId oddbGetRenderGlobalObjectId(OdDbDatabase* pDb, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbRenderGlobalPtr oddbGetRenderGlobalObject(OdDbDatabase* pDb, OdDb::OpenMode mode, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbObjectId oddbGetRenderEnvironmentObjectId(OdDbDatabase* pDb, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbRenderEnvironmentPtr oddbGetRenderEnvironmentObject(OdDbDatabase* pDb, OdDb::OpenMode mode, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbObjectId oddbGetActiveRenderSettingsObjectId(OdDbDatabase* pDb, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbRenderSettingsPtr oddbGetActiveRenderSettingsObject(OdDbDatabase* pDb, OdDb::OpenMode mode, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbObjectId oddbGetRenderEntriesDictionaryId(OdDbDatabase* pDb, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbDictionaryPtr oddbGetRenderEntriesDictionary(OdDbDatabase* pDb, OdDb::OpenMode mode, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbObjectId oddbGetRenderRapidRTSettingsDictionaryId(OdDbDatabase* pDb, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbDictionaryPtr oddbGetRenderRapidRTSettingsDictionary(OdDbDatabase* pDb, OdDb::OpenMode mode, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbObjectId oddbGetActiveRenderRapidRTSettingsObjectId(OdDbDatabase* pDb, bool createIfNotFound = false);
TOOLKIT_EXPORT OdDbRenderSettingsPtr oddbGetActiveRenderRapidRTSettingsObject(OdDbDatabase* pDb, OdDb::OpenMode mode, bool createIfNotFound = false);
 
#endif