[occt.git] / src / Graphic3d / Graphic3d_RenderingParams.hxx

// Created on: 2014-05-14
// Created by: Denis BOGOLEPOV
// Copyright (c) 2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Graphic3d_RenderingParams_HeaderFile
#define _Graphic3d_RenderingParams_HeaderFile

#include <Graphic3d_RenderingMode.hxx>
#include <Graphic3d_StereoMode.hxx>
#include <Graphic3d_Mat4.hxx>
#include <Graphic3d_Vec4.hxx>

//! Helper class to store rendering parameters.
class Graphic3d_RenderingParams
{
public:
  //! Default pixels density.
  static const unsigned int THE_DEFAULT_RESOLUTION = 72u;

  //! Default number of samples per pixel.
  static const Standard_Integer THE_DEFAULT_SPP = 1;

  //! Default ray-tracing depth.
  static const Standard_Integer THE_DEFAULT_DEPTH = 3;

  //! Anaglyph filter presets.
  enum Anaglyph
  {
    Anaglyph_RedCyan_Simple,       //!< simple    filter for Red-Cyan      glasses (R+GB)
    Anaglyph_RedCyan_Optimized,    //!< optimized filter for Red-Cyan      glasses (R+GB)
    Anaglyph_YellowBlue_Simple,    //!< simple    filter for Yellow-Blue   glasses (RG+B)
    Anaglyph_YellowBlue_Optimized, //!< optimized filter for Yellow-Blue   glasses (RG+B)
    Anaglyph_GreenMagenta_Simple,  //!< simple    filter for Green-Magenta glasses (G+RB)
    Anaglyph_UserDefined           //!< use externally specified matrices
  };

public:

  //! Creates default rendering parameters.
  Graphic3d_RenderingParams()
  : Method                      (Graphic3d_RM_RASTERIZATION),
    NbMsaaSamples               (0),
    // ray tracing parameters
    IsGlobalIlluminationEnabled (Standard_False),
    SamplesPerPixel             (THE_DEFAULT_SPP),
    RaytracingDepth             (THE_DEFAULT_DEPTH),
    IsShadowEnabled             (Standard_True),
    IsReflectionEnabled         (Standard_False),
    IsAntialiasingEnabled       (Standard_False),
    IsTransparentShadowEnabled  (Standard_False),
    UseEnvironmentMapBackground (Standard_False),
    CoherentPathTracingMode     (Standard_False),
    AdaptiveScreenSampling      (Standard_False),
    ShowSamplingTiles           (Standard_False),
    // stereoscopic parameters
    StereoMode (Graphic3d_StereoMode_QuadBuffer),
    AnaglyphFilter (Anaglyph_RedCyan_Optimized),
    ToReverseStereo (Standard_False),

    Resolution (THE_DEFAULT_RESOLUTION)
  {
    const Graphic3d_Vec4 aZero (0.0f, 0.0f, 0.0f, 0.0f);
    AnaglyphLeft .SetRow (0, Graphic3d_Vec4 (1.0f,  0.0f,  0.0f, 0.0f));
    AnaglyphLeft .SetRow (1, aZero);
    AnaglyphLeft .SetRow (2, aZero);
    AnaglyphLeft .SetRow (3, aZero);
    AnaglyphRight.SetRow (0, aZero);
    AnaglyphRight.SetRow (1, Graphic3d_Vec4 (0.0f,  1.0f,  0.0f, 0.0f));
    AnaglyphRight.SetRow (2, Graphic3d_Vec4 (0.0f,  0.0f,  1.0f, 0.0f));
    AnaglyphRight.SetRow (3, aZero);
  }

  //! Returns resolution ratio.
  Standard_ShortReal ResolutionRatio() const
  {
    return Resolution / static_cast<Standard_ShortReal> (THE_DEFAULT_RESOLUTION);
  }

public:

  Graphic3d_RenderingMode Method;                      //!< specifies rendering mode, Graphic3d_RM_RASTERIZATION by default
  Standard_Integer        NbMsaaSamples;               //!< number of MSAA samples (should be within 0..GL_MAX_SAMPLES, power-of-two number), 0 by default

  Standard_Boolean        IsGlobalIlluminationEnabled; //!< enables/disables global illumination effects (path tracing)
  Standard_Integer        SamplesPerPixel;             //!< number of samples per pixel (SPP)
  Standard_Integer        RaytracingDepth;             //!< maximum ray-tracing depth, 3 by default
  Standard_Boolean        IsShadowEnabled;             //!< enables/disables shadows rendering, True by default
  Standard_Boolean        IsReflectionEnabled;         //!< enables/disables specular reflections, False by default
  Standard_Boolean        IsAntialiasingEnabled;       //!< enables/disables adaptive anti-aliasing, False by default
  Standard_Boolean        IsTransparentShadowEnabled;  //!< enables/disables light propagation through transparent media, False by default
  Standard_Boolean        UseEnvironmentMapBackground; //!< enables/disables environment map background
  Standard_Boolean        CoherentPathTracingMode;     //!< enables/disables 'coherent' tracing mode (single RNG seed within 16x16 image blocks)
  Standard_Boolean        AdaptiveScreenSampling;      //!< enables/disables adaptive screen sampling mode for path tracing, FALSE by default
  Standard_Boolean        ShowSamplingTiles;           //!< enables/disables debug mode for adaptive screen sampling, FALSE by default

  Graphic3d_StereoMode    StereoMode;                  //!< stereoscopic output mode, Graphic3d_StereoMode_QuadBuffer by default
  Anaglyph                AnaglyphFilter;              //!< filter for anaglyph output, Anaglyph_RedCyan_Optimized by default
  Graphic3d_Mat4          AnaglyphLeft;                //!< left  anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
  Graphic3d_Mat4          AnaglyphRight;               //!< right anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
  Standard_Boolean        ToReverseStereo;             //!< flag to reverse stereo pair, FALSE by default

  unsigned int            Resolution;                  //!< Pixels density (PPI), defines scaling factor for parameters like text size
                                                       //!< (when defined in screen-space units rather than in 3D) to be properly displayed
                                                       //!< on device (screen / printer). 72 is default value.
                                                       //!< Note that using difference resolution in different Views in same Viewer
                                                       //!< will lead to performance regression (for example, text will be recreated every time).

};

#endif // _Graphic3d_RenderingParams_HeaderFile
Commit	Line	Data
bc8c79bb	1	// Created on: 2014-05-14
	2	// Created by: Denis BOGOLEPOV
	3	// Copyright (c) 2014 OPEN CASCADE SAS
	4	//
	5	// This file is part of Open CASCADE Technology software library.
	6	//
	7	// This library is free software; you can redistribute it and/or modify it under
	8	// the terms of the GNU Lesser General Public License version 2.1 as published
	9	// by the Free Software Foundation, with special exception defined in the file
	10	// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
	11	// distribution for complete text of the license and disclaimer of any warranty.
	12	//
	13	// Alternatively, this file may be used under the terms of Open CASCADE
	14	// commercial license or contractual agreement.
	15
	16	#ifndef _Graphic3d_RenderingParams_HeaderFile
	17	#define _Graphic3d_RenderingParams_HeaderFile
	18
	19	#include <Graphic3d_RenderingMode.hxx>
f978241f	20	#include <Graphic3d_StereoMode.hxx>
	21	#include <Graphic3d_Mat4.hxx>
	22	#include <Graphic3d_Vec4.hxx>
bc8c79bb	23
	24	//! Helper class to store rendering parameters.
	25	class Graphic3d_RenderingParams
	26	{
	27	public:
4b1c8733	28	//! Default pixels density.
4b1c8733	29	static const unsigned int THE_DEFAULT_RESOLUTION = 72u;
bc8c79bb	30
189f85a3	31	//! Default number of samples per pixel.
	32	static const Standard_Integer THE_DEFAULT_SPP = 1;
	33
bc8c79bb	34	//! Default ray-tracing depth.
	35	static const Standard_Integer THE_DEFAULT_DEPTH = 3;
	36
f978241f	37	//! Anaglyph filter presets.
	38	enum Anaglyph
	39	{
	40	Anaglyph_RedCyan_Simple, //!< simple filter for Red-Cyan glasses (R+GB)
	41	Anaglyph_RedCyan_Optimized, //!< optimized filter for Red-Cyan glasses (R+GB)
	42	Anaglyph_YellowBlue_Simple, //!< simple filter for Yellow-Blue glasses (RG+B)
	43	Anaglyph_YellowBlue_Optimized, //!< optimized filter for Yellow-Blue glasses (RG+B)
	44	Anaglyph_GreenMagenta_Simple, //!< simple filter for Green-Magenta glasses (G+RB)
	45	Anaglyph_UserDefined //!< use externally specified matrices
	46	};
	47
bc8c79bb	48	public:
	49
	50	//! Creates default rendering parameters.
	51	Graphic3d_RenderingParams()
189f85a3	52	: Method (Graphic3d_RM_RASTERIZATION),
3c4b62a4	53	NbMsaaSamples (0),
3c4b62a4	54	// ray tracing parameters
f978241f	55	IsGlobalIlluminationEnabled (Standard_False),
189f85a3	56	SamplesPerPixel (THE_DEFAULT_SPP),
f978241f	57	RaytracingDepth (THE_DEFAULT_DEPTH),
189f85a3	58	IsShadowEnabled (Standard_True),
	59	IsReflectionEnabled (Standard_False),
	60	IsAntialiasingEnabled (Standard_False),
	61	IsTransparentShadowEnabled (Standard_False),
f978241f	62	UseEnvironmentMapBackground (Standard_False),
8c820969	63	CoherentPathTracingMode (Standard_False),
3a9b5dc8	64	AdaptiveScreenSampling (Standard_False),
3a9b5dc8	65	ShowSamplingTiles (Standard_False),
3c4b62a4	66	// stereoscopic parameters
f978241f	67	StereoMode (Graphic3d_StereoMode_QuadBuffer),
f978241f	68	AnaglyphFilter (Anaglyph_RedCyan_Optimized),
4b1c8733	69	ToReverseStereo (Standard_False),
	70
	71	Resolution (THE_DEFAULT_RESOLUTION)
bc8c79bb	72	{
f978241f	73	const Graphic3d_Vec4 aZero (0.0f, 0.0f, 0.0f, 0.0f);
	74	AnaglyphLeft .SetRow (0, Graphic3d_Vec4 (1.0f, 0.0f, 0.0f, 0.0f));
	75	AnaglyphLeft .SetRow (1, aZero);
	76	AnaglyphLeft .SetRow (2, aZero);
	77	AnaglyphLeft .SetRow (3, aZero);
	78	AnaglyphRight.SetRow (0, aZero);
	79	AnaglyphRight.SetRow (1, Graphic3d_Vec4 (0.0f, 1.0f, 0.0f, 0.0f));
	80	AnaglyphRight.SetRow (2, Graphic3d_Vec4 (0.0f, 0.0f, 1.0f, 0.0f));
	81	AnaglyphRight.SetRow (3, aZero);
bc8c79bb	82	}
bc8c79bb	83
75c262a9	84	//! Returns resolution ratio.
	85	Standard_ShortReal ResolutionRatio() const
	86	{
	87	return Resolution / static_cast<Standard_ShortReal> (THE_DEFAULT_RESOLUTION);
	88	}
	89
bc8c79bb	90	public:
bc8c79bb	91
f978241f	92	Graphic3d_RenderingMode Method; //!< specifies rendering mode, Graphic3d_RM_RASTERIZATION by default
3c4b62a4	93	Standard_Integer NbMsaaSamples; //!< number of MSAA samples (should be within 0..GL_MAX_SAMPLES, power-of-two number), 0 by default
f978241f	94
	95	Standard_Boolean IsGlobalIlluminationEnabled; //!< enables/disables global illumination effects (path tracing)
	96	Standard_Integer SamplesPerPixel; //!< number of samples per pixel (SPP)
	97	Standard_Integer RaytracingDepth; //!< maximum ray-tracing depth, 3 by default
	98	Standard_Boolean IsShadowEnabled; //!< enables/disables shadows rendering, True by default
	99	Standard_Boolean IsReflectionEnabled; //!< enables/disables specular reflections, False by default
	100	Standard_Boolean IsAntialiasingEnabled; //!< enables/disables adaptive anti-aliasing, False by default
	101	Standard_Boolean IsTransparentShadowEnabled; //!< enables/disables light propagation through transparent media, False by default
	102	Standard_Boolean UseEnvironmentMapBackground; //!< enables/disables environment map background
8c820969	103	Standard_Boolean CoherentPathTracingMode; //!< enables/disables 'coherent' tracing mode (single RNG seed within 16x16 image blocks)
3a9b5dc8	104	Standard_Boolean AdaptiveScreenSampling; //!< enables/disables adaptive screen sampling mode for path tracing, FALSE by default
3a9b5dc8	105	Standard_Boolean ShowSamplingTiles; //!< enables/disables debug mode for adaptive screen sampling, FALSE by default
f978241f	106
	107	Graphic3d_StereoMode StereoMode; //!< stereoscopic output mode, Graphic3d_StereoMode_QuadBuffer by default
	108	Anaglyph AnaglyphFilter; //!< filter for anaglyph output, Anaglyph_RedCyan_Optimized by default
	109	Graphic3d_Mat4 AnaglyphLeft; //!< left anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
	110	Graphic3d_Mat4 AnaglyphRight; //!< right anaglyph filter (in normalized colorspace), Color = AnaglyphRight * theColorRight + AnaglyphLeft * theColorLeft;
	111	Standard_Boolean ToReverseStereo; //!< flag to reverse stereo pair, FALSE by default
189f85a3	112
4b1c8733	113	unsigned int Resolution; //!< Pixels density (PPI), defines scaling factor for parameters like text size
	114	//!< (when defined in screen-space units rather than in 3D) to be properly displayed
	115	//!< on device (screen / printer). 72 is default value.
	116	//!< Note that using difference resolution in different Views in same Viewer
	117	//!< will lead to performance regression (for example, text will be recreated every time).
	118
bc8c79bb	119	};
	120
	121	#endif // _Graphic3d_RenderingParams_HeaderFile