0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / Graphic3d / Graphic3d_ZLayerSettings.hxx
1 // Copyright (c) 2014 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _Graphic3d_ZLayerSettings_HeaderFile
15 #define _Graphic3d_ZLayerSettings_HeaderFile
16
17 #include <gp_XYZ.hxx>
18 #include <Geom_Transformation.hxx>
19 #include <Graphic3d_LightSet.hxx>
20 #include <Graphic3d_PolygonOffset.hxx>
21 #include <Precision.hxx>
22 #include <Standard_Dump.hxx>
23 #include <TCollection_AsciiString.hxx>
24
25 enum Graphic3d_ZLayerSetting
26 {
27   Graphic3d_ZLayerDepthTest = 1,
28   Graphic3d_ZLayerDepthWrite = 2,
29   Graphic3d_ZLayerDepthClear = 4,
30   Graphic3d_ZLayerDepthOffset = 8
31 };
32
33 //! Structure defines list of ZLayer properties.
34 struct Graphic3d_ZLayerSettings
35 {
36
37   //! Default settings.
38   Graphic3d_ZLayerSettings()
39   : myCullingDistance (Precision::Infinite()),
40     myCullingSize     (Precision::Infinite()),
41     myIsImmediate       (Standard_False),
42     myToRaytrace        (Standard_True),
43     myUseEnvironmentTexture (Standard_True),
44     myToEnableDepthTest (Standard_True),
45     myToEnableDepthWrite(Standard_True),
46     myToClearDepth      (Standard_True),
47     myToRenderInDepthPrepass (Standard_True) {}
48
49   //! Return user-provided name.
50   const TCollection_AsciiString& Name() const { return myName; }
51
52   //! Set custom name.
53   void SetName (const TCollection_AsciiString& theName) { myName = theName; }
54
55   //! Return lights list to be used for rendering presentations within this Z-Layer; NULL by default.
56   //! NULL list (but not empty list!) means that default lights assigned to the View should be used instead of per-layer lights.
57   const Handle(Graphic3d_LightSet)& Lights() const { return myLights; }
58
59   //! Assign lights list to be used.
60   void SetLights (const Handle(Graphic3d_LightSet)& theLights) { myLights = theLights; }
61
62   //! Return the origin of all objects within the layer.
63   const gp_XYZ& Origin() const { return myOrigin; }
64
65   //! Return the transformation to the origin.
66   const Handle(Geom_Transformation)& OriginTransformation() const { return myOriginTrsf; }
67
68   //! Set the origin of all objects within the layer.
69   void SetOrigin (const gp_XYZ& theOrigin)
70   {
71     myOrigin = theOrigin;
72     myOriginTrsf.Nullify();
73     if (!theOrigin.IsEqual (gp_XYZ(0.0, 0.0, 0.0), gp::Resolution()))
74     {
75       myOriginTrsf = new Geom_Transformation();
76       myOriginTrsf->SetTranslation (theOrigin);
77     }
78   }
79
80   //! Return TRUE, if culling of distant objects (distance culling) should be performed; FALSE by default.
81   //! @sa CullingDistance()
82   Standard_Boolean HasCullingDistance() const { return !Precision::IsInfinite (myCullingDistance) && myCullingDistance > 0.0; }
83
84   //! Return the distance to discard drawing of distant objects (distance from camera Eye point); by default it is Infinite (distance culling is disabled).
85   //! Since camera eye definition has no strong meaning within orthographic projection, option is considered only within perspective projection.
86   //! Note also that this option has effect only when frustum culling is enabled.
87   Standard_Real CullingDistance() const { return myCullingDistance; }
88
89   //! Set the distance to discard drawing objects.
90   void SetCullingDistance (Standard_Real theDistance) { myCullingDistance = theDistance; }
91
92   //! Return TRUE, if culling of small objects (size culling) should be performed; FALSE by default.
93   //! @sa CullingSize()
94   Standard_Boolean HasCullingSize() const { return !Precision::IsInfinite (myCullingSize) && myCullingSize > 0.0; }
95
96   //! Return the size to discard drawing of small objects; by default it is Infinite (size culling is disabled).
97   //! Current implementation checks the length of projected diagonal of bounding box in pixels for discarding.
98   //! Note that this option has effect only when frustum culling is enabled.
99   Standard_Real CullingSize() const { return myCullingSize; }
100
101   //! Set the distance to discard drawing objects.
102   void SetCullingSize (Standard_Real theSize) { myCullingSize = theSize; }
103
104   //! Return true if this layer should be drawn after all normal (non-immediate) layers.
105   Standard_Boolean IsImmediate() const { return myIsImmediate; }
106
107   //! Set the flag indicating the immediate layer, which should be drawn after all normal (non-immediate) layers.
108   void SetImmediate (const Standard_Boolean theValue) { myIsImmediate = theValue; }
109
110   //! Returns TRUE if layer should be processed by ray-tracing renderer; TRUE by default.
111   //! Note that this flag is IGNORED for layers with IsImmediate() flag.
112   Standard_Boolean IsRaytracable() const { return myToRaytrace; }
113
114   //! Sets if layer should be processed by ray-tracing renderer.
115   void SetRaytracable (Standard_Boolean theToRaytrace) { myToRaytrace = theToRaytrace; }
116
117   //! Return flag to allow/prevent environment texture mapping usage for specific layer.
118   Standard_Boolean UseEnvironmentTexture() const { return myUseEnvironmentTexture; }
119
120   //! Set the flag to allow/prevent environment texture mapping usage for specific layer.
121   void SetEnvironmentTexture (const Standard_Boolean theValue) { myUseEnvironmentTexture = theValue; }
122
123   //! Return true if depth test should be enabled.
124   Standard_Boolean ToEnableDepthTest() const { return myToEnableDepthTest; }
125
126   //! Set if depth test should be enabled.
127   void SetEnableDepthTest(const Standard_Boolean theValue) { myToEnableDepthTest = theValue; }
128
129   //! Return true depth values should be written during rendering.
130   Standard_Boolean ToEnableDepthWrite() const { return myToEnableDepthWrite; }
131
132   //! Set if depth values should be written during rendering.
133   void SetEnableDepthWrite (const Standard_Boolean theValue) { myToEnableDepthWrite = theValue; }
134
135   //! Return true if depth values should be cleared before drawing the layer.
136   Standard_Boolean ToClearDepth() const { return myToClearDepth; }
137
138   //! Set if depth values should be cleared before drawing the layer.
139   void SetClearDepth (const Standard_Boolean theValue) { myToClearDepth = theValue; }
140
141   //! Return TRUE if layer should be rendered within depth pre-pass; TRUE by default.
142   Standard_Boolean ToRenderInDepthPrepass() const { return myToRenderInDepthPrepass; }
143
144   //! Set if layer should be rendered within depth pre-pass.
145   void SetRenderInDepthPrepass (Standard_Boolean theToRender) { myToRenderInDepthPrepass = theToRender; }
146
147   //! Return glPolygonOffset() arguments.
148   const Graphic3d_PolygonOffset& PolygonOffset() const { return myPolygonOffset; }
149
150   //! Setup glPolygonOffset() arguments.
151   void SetPolygonOffset (const Graphic3d_PolygonOffset& theParams) { myPolygonOffset = theParams; }
152
153   //! Modify glPolygonOffset() arguments.
154   Graphic3d_PolygonOffset& ChangePolygonOffset() { return myPolygonOffset; }
155
156   //! Returns true if theSetting is enabled.
157   Standard_DEPRECATED("Deprecated method IsSettingEnabled() should be replaced by individual property getters")
158   Standard_Boolean IsSettingEnabled (const Graphic3d_ZLayerSetting theSetting) const
159   {
160     switch (theSetting)
161     {
162       case Graphic3d_ZLayerDepthTest:   return myToEnableDepthTest;
163       case Graphic3d_ZLayerDepthWrite:  return myToEnableDepthWrite;
164       case Graphic3d_ZLayerDepthClear:  return myToClearDepth;
165       case Graphic3d_ZLayerDepthOffset: return myPolygonOffset.Mode != Aspect_POM_Off;
166     }
167     return Standard_False;
168   }
169
170   //! Enables theSetting
171   Standard_DEPRECATED("Deprecated method EnableSetting() should be replaced by individual property getters")
172   void EnableSetting (const Graphic3d_ZLayerSetting theSetting)
173   {
174     switch (theSetting)
175     {
176       case Graphic3d_ZLayerDepthTest:   myToEnableDepthTest  = Standard_True; return;
177       case Graphic3d_ZLayerDepthWrite:  myToEnableDepthWrite = Standard_True; return;
178       case Graphic3d_ZLayerDepthClear:  myToClearDepth       = Standard_True; return;
179       case Graphic3d_ZLayerDepthOffset: myPolygonOffset.Mode = Aspect_POM_Fill; return;
180     }
181   }
182
183   //! Disables theSetting
184   Standard_DEPRECATED("Deprecated method DisableSetting() should be replaced by individual property getters")
185   void DisableSetting (const Graphic3d_ZLayerSetting theSetting)
186   {
187     switch (theSetting)
188     {
189       case Graphic3d_ZLayerDepthTest:   myToEnableDepthTest  = Standard_False; return;
190       case Graphic3d_ZLayerDepthWrite:  myToEnableDepthWrite = Standard_False; return;
191       case Graphic3d_ZLayerDepthClear:  myToClearDepth       = Standard_False; return;
192       case Graphic3d_ZLayerDepthOffset: myPolygonOffset.Mode = Aspect_POM_Off; return;
193     }
194   }
195
196   //! Sets minimal possible positive depth offset.
197   void SetDepthOffsetPositive()
198   {
199     myPolygonOffset.Mode   = Aspect_POM_Fill;
200     myPolygonOffset.Factor = 1.0f;
201     myPolygonOffset.Units  = 1.0f;
202   }
203
204   //! Sets minimal possible negative depth offset.
205   void SetDepthOffsetNegative()
206   {
207     myPolygonOffset.Mode   = Aspect_POM_Fill;
208     myPolygonOffset.Factor = 1.0f;
209     myPolygonOffset.Units  =-1.0f;
210   }
211
212   //! Dumps the content of me into the stream
213   void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const
214   {
215     OCCT_DUMP_CLASS_BEGIN (theOStream, Graphic3d_ZLayerSettings)
216
217     OCCT_DUMP_FIELD_VALUE_STRING (theOStream, myName)
218     OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, myOriginTrsf.get())
219     OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &myOrigin)
220
221     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myCullingDistance)
222     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myCullingSize)
223
224     OCCT_DUMP_FIELD_VALUES_DUMPED (theOStream, theDepth, &myPolygonOffset)
225
226     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myIsImmediate)
227     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myToRaytrace)
228     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myUseEnvironmentTexture)
229     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myToEnableDepthTest)
230     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myToEnableDepthWrite)
231     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myToClearDepth)
232     OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myToRenderInDepthPrepass)
233   }
234
235 protected:
236
237   TCollection_AsciiString     myName;                  //!< user-provided name
238   Handle(Graphic3d_LightSet)  myLights;                //!< lights list
239   Handle(Geom_Transformation) myOriginTrsf;            //!< transformation to the origin
240   gp_XYZ                      myOrigin;                //!< the origin of all objects within the layer
241   Standard_Real               myCullingDistance;       //!< distance to discard objects
242   Standard_Real               myCullingSize;           //!< size to discard objects
243   Graphic3d_PolygonOffset     myPolygonOffset;         //!< glPolygonOffset() arguments
244   Standard_Boolean            myIsImmediate;           //!< immediate layer will be drawn after all normal layers
245   Standard_Boolean            myToRaytrace;            //!< option to render layer within ray-tracing engine
246   Standard_Boolean            myUseEnvironmentTexture; //!< flag to allow/prevent environment texture mapping usage for specific layer
247   Standard_Boolean            myToEnableDepthTest;     //!< option to enable depth test
248   Standard_Boolean            myToEnableDepthWrite;    //!< option to enable write depth values
249   Standard_Boolean            myToClearDepth;          //!< option to clear depth values before drawing the layer
250   Standard_Boolean            myToRenderInDepthPrepass;//!< option to render layer within depth pre-pass
251
252 };
253
254 #endif // _Graphic3d_ZLayerSettings_HeaderFile