0024887: Visualization - revise and extend Raytracing controls
[occt.git] / src / Graphic3d / Graphic3d_RenderingParams.hxx
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>
20
21 //! Helper class to store rendering parameters.
22 class Graphic3d_RenderingParams
23 {
24 public:
25
26   //! Default ray-tracing depth.
27   static const Standard_Integer THE_DEFAULT_DEPTH = 3;
28
29 public:
30
31   //! Creates default rendering parameters.
32   Graphic3d_RenderingParams()
33   : Method (Graphic3d_RM_RASTERIZATION),
34     RaytracingDepth (THE_DEFAULT_DEPTH),
35     IsShadowEnabled (Standard_True),
36     IsReflectionEnabled (Standard_False),
37     IsAntialiasingEnabled (Standard_False),
38     IsTransparentShadowEnabled (Standard_False)
39   {
40     //
41   }
42
43 public:
44
45   //! Specifies rendering mode.
46   Graphic3d_RenderingMode Method;
47
48   //! Maximum ray-tracing depth.
49   Standard_Integer RaytracingDepth;
50
51   //! Enables/disables shadows rendering.
52   Standard_Boolean IsShadowEnabled;
53
54   //! Enables/disables specular reflections.
55   Standard_Boolean IsReflectionEnabled;
56   
57   //! Enables/disables adaptive anti-aliasing.
58   Standard_Boolean IsAntialiasingEnabled;
59
60   //! Enables/disables light propagation through transparent media.
61   Standard_Boolean IsTransparentShadowEnabled;
62
63 };
64
65 #endif // _Graphic3d_RenderingParams_HeaderFile