c357e426 |
1 | // Copyright (c) 2015 OPEN CASCADE SAS |
b311480e |
2 | // |
973c2be1 |
3 | // This file is part of Open CASCADE Technology software library. |
b311480e |
4 | // |
d5f74e42 |
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 |
973c2be1 |
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. |
b311480e |
10 | // |
973c2be1 |
11 | // Alternatively, this file may be used under the terms of Open CASCADE |
12 | // commercial license or contractual agreement. |
b311480e |
13 | |
7fd59977 |
14 | #ifndef _Graphic3d_CView_HeaderFile |
15 | #define _Graphic3d_CView_HeaderFile |
16 | |
c357e426 |
17 | #include <Aspect_Handle.hxx> |
c357e426 |
18 | #include <Aspect_RenderingContext.hxx> |
c357e426 |
19 | #include <Aspect_TypeOfUpdate.hxx> |
20 | #include <Aspect_Window.hxx> |
21 | #include <Graphic3d_BufferType.hxx> |
b5ac8292 |
22 | #include <Graphic3d_Camera.hxx> |
12381341 |
23 | #include <Graphic3d_CLight.hxx> |
c357e426 |
24 | #include <Graphic3d_CStructure.hxx> |
25 | #include <Graphic3d_DataStructureManager.hxx> |
26d9c835 |
26 | #include <Graphic3d_DiagnosticInfo.hxx> |
c357e426 |
27 | #include <Graphic3d_ExportFormat.hxx> |
28 | #include <Graphic3d_GraduatedTrihedron.hxx> |
29 | #include <Graphic3d_MapOfStructure.hxx> |
30 | #include <Graphic3d_NMapOfTransient.hxx> |
c357e426 |
31 | #include <Graphic3d_RenderingParams.hxx> |
51b10cd4 |
32 | #include <Graphic3d_SequenceOfHClipPlane.hxx> |
c357e426 |
33 | #include <Graphic3d_SequenceOfStructure.hxx> |
34 | #include <Graphic3d_SortType.hxx> |
35 | #include <Graphic3d_Structure.hxx> |
c357e426 |
36 | #include <Graphic3d_TextureEnv.hxx> |
37 | #include <Graphic3d_TypeOfAnswer.hxx> |
38 | #include <Graphic3d_TypeOfBackfacingModel.hxx> |
39 | #include <Graphic3d_TypeOfShadingModel.hxx> |
c357e426 |
40 | #include <Graphic3d_TypeOfVisualization.hxx> |
41 | #include <Graphic3d_Vec3.hxx> |
42 | #include <Graphic3d_ZLayerId.hxx> |
43 | #include <Graphic3d_ZLayerSettings.hxx> |
44 | #include <Image_PixMap.hxx> |
45 | #include <Quantity_NameOfColor.hxx> |
46 | #include <Standard_Address.hxx> |
47 | #include <Standard_Transient.hxx> |
26d9c835 |
48 | #include <TColStd_IndexedDataMapOfStringString.hxx> |
c357e426 |
49 | |
50 | class Graphic3d_CView; |
51 | class Graphic3d_GraphicDriver; |
52 | class Graphic3d_StructureManager; |
53 | |
54 | DEFINE_STANDARD_HANDLE (Graphic3d_CView, Graphic3d_DataStructureManager) |
55 | |
56 | //! Base class of a graphical view that carries out rendering process for a concrete |
57 | //! implementation of graphical driver. Provides virtual interfaces for redrawing its |
58 | //! contents, management of displayed structures and render settings. The source code |
59 | //! of the class itself implements functionality related to management of |
60 | //! computed (HLR or "view-dependent") structures. |
61 | class Graphic3d_CView : public Graphic3d_DataStructureManager |
bf75be98 |
62 | { |
bf75be98 |
63 | public: |
64 | |
c357e426 |
65 | //! Constructor. |
66 | Standard_EXPORT Graphic3d_CView (const Handle(Graphic3d_StructureManager)& theMgr); |
67 | |
68 | //! Destructor. |
69 | Standard_EXPORT virtual ~Graphic3d_CView(); |
70 | |
71 | //! Returns the identification number of the view. |
72 | Standard_Integer Identification() const { return myId; } |
73 | |
74 | //! Activates the view. Map the associated window on the screen and post the view in this window. |
75 | //! Warning: Raises ViewDefinitionError if the associated window isn't defined. |
76 | Standard_EXPORT virtual void Activate(); |
77 | |
78 | //! Deactivates the view. Unmap the associated window on the screen and unpost the view in this window. |
79 | //! Warning: Raises ViewDefinitionError if the associated window isn't defined. |
80 | Standard_EXPORT virtual void Deactivate(); |
81 | |
82 | //! Returns the activity flag of the view. |
83 | Standard_Boolean IsActive() const { return myIsActive; } |
84 | |
85 | //! Erases the view and removes from graphic driver. |
86 | //! No more graphic operations are allowed in this view after the call. |
87 | Standard_EXPORT virtual void Remove(); |
88 | |
89 | //! Returns true if the view was removed. |
90 | Standard_Boolean IsRemoved() const { return myIsRemoved; } |
bf75be98 |
91 | |
92 | public: |
93 | |
c357e426 |
94 | //! Returns visualization type of the view. |
95 | Graphic3d_TypeOfVisualization VisualizationType() const { return myVisualization; } |
bf75be98 |
96 | |
c357e426 |
97 | //! Sets visualization type of the view. |
98 | void SetVisualizationType (const Graphic3d_TypeOfVisualization theType) { myVisualization = theType; } |
bf75be98 |
99 | |
c357e426 |
100 | //! Switches computed HLR mode in the view |
101 | Standard_EXPORT void SetComputedMode (const Standard_Boolean theMode); |
bf75be98 |
102 | |
c357e426 |
103 | //! Returns the computed HLR mode state |
104 | Standard_Boolean ComputedMode() const { return myIsInComputedMode; } |
bf75be98 |
105 | |
c357e426 |
106 | //! Computes the new presentation of the structure displayed in this view with the type Graphic3d_TOS_COMPUTED. |
107 | Standard_EXPORT void ReCompute (const Handle(Graphic3d_Structure)& theStructure); |
bf75be98 |
108 | |
50d06d8f |
109 | //! Updates screen in function of modifications of the structures |
110 | //! and invalidates bounding box of specified ZLayerId. |
111 | Standard_EXPORT void Update (const Aspect_TypeOfUpdate theUpdateMode, |
112 | const Graphic3d_ZLayerId theLayerId = Graphic3d_ZLayerId_UNKNOWN); |
bf75be98 |
113 | |
c357e426 |
114 | //! Returns Standard_True if one of the structures displayed in the view contains Polygons, Triangles or Quadrangles. |
115 | Standard_EXPORT Standard_Boolean ContainsFacet() const; |
bf75be98 |
116 | |
c357e426 |
117 | //! Returns Standard_True if one of the structures in the set contains Polygons, Triangles or Quadrangles. |
118 | Standard_EXPORT Standard_Boolean ContainsFacet (const Graphic3d_MapOfStructure& theSet) const; |
bf75be98 |
119 | |
c357e426 |
120 | //! Returns the set of structures displayed in this view. |
121 | Standard_EXPORT void DisplayedStructures (Graphic3d_MapOfStructure& theStructures) const; |
b5ac8292 |
122 | |
c357e426 |
123 | //! Returns number of displayed structures in the view. |
124 | Standard_Integer NumberOfDisplayedStructures() const { return myStructsDisplayed.Extent(); } |
bf75be98 |
125 | |
c357e426 |
126 | //! Returns map of objects hidden within this specific view (not viewer-wise). |
127 | const Handle(Graphic3d_NMapOfTransient)& HiddenObjects() const { return myHiddenObjects; } |
128 | |
129 | //! Returns map of objects hidden within this specific view (not viewer-wise). |
130 | Handle(Graphic3d_NMapOfTransient)& ChangeHiddenObjects() { return myHiddenObjects; } |
131 | |
132 | //! Returns Standard_True in case if the structure with the given <theStructId> is |
133 | //! in list of structures to be computed and stores computed struct to <theComputedStruct>. |
134 | Standard_EXPORT Standard_Boolean IsComputed (const Standard_Integer theStructId, |
135 | Handle(Graphic3d_Structure)& theComputedStruct) const; |
136 | |
50d06d8f |
137 | //! Returns the bounding box of all structures displayed in the view. |
3fe9ce0e |
138 | //! If theToIncludeAuxiliary is TRUE, then the boundary box also includes minimum and maximum limits |
139 | //! of graphical elements forming parts of infinite and other auxiliary structures. |
140 | //! @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence) |
141 | //! @return computed bounding box |
142 | Standard_EXPORT Bnd_Box MinMaxValues (const Standard_Boolean theToIncludeAuxiliary = Standard_False) const; |
c357e426 |
143 | |
144 | //! Returns the coordinates of the boundary box of all structures in the set <theSet>. |
145 | //! If <theToIgnoreInfiniteFlag> is TRUE, then the boundary box |
146 | //! also includes minimum and maximum limits of graphical elements |
147 | //! forming parts of infinite structures. |
148 | Standard_EXPORT Bnd_Box MinMaxValues (const Graphic3d_MapOfStructure& theSet, |
3fe9ce0e |
149 | const Standard_Boolean theToIncludeAuxiliary = Standard_False) const; |
c357e426 |
150 | |
151 | //! Returns the structure manager handle which manage structures associated with this view. |
152 | const Handle(Graphic3d_StructureManager)& StructureManager() const { return myStructureManager; } |
153 | |
154 | private: |
155 | |
156 | friend class Graphic3d_StructureManager; |
157 | |
158 | //! Is it possible to display the structure in the view? |
159 | Standard_EXPORT Graphic3d_TypeOfAnswer acceptDisplay (const Graphic3d_TypeOfStructure theStructType) const; |
160 | |
161 | //! Computes the new presentation of the structures displayed in this view with the type Graphic3d_TOS_COMPUTED. |
162 | Standard_EXPORT void Compute(); |
163 | |
164 | //! Clears the structure in this view. |
165 | Standard_EXPORT void Clear (const Handle(Graphic3d_Structure)& theStructure, const Standard_Boolean theWithDestruction); |
166 | |
167 | //! Connects the structures. |
168 | Standard_EXPORT void Connect (const Handle(Graphic3d_Structure)& theMother, |
169 | const Handle(Graphic3d_Structure)& theDaughter); |
170 | |
171 | //! Disconnects the structures. |
172 | Standard_EXPORT void Disconnect (const Handle(Graphic3d_Structure)& theMother, |
173 | const Handle(Graphic3d_Structure)& theDaughter); |
174 | |
175 | //! Displays the structure in the view. |
176 | Standard_EXPORT void Display (const Handle(Graphic3d_Structure)& theStructure); |
177 | |
178 | //! Display the structure in the view. |
179 | Standard_EXPORT void Display (const Handle(Graphic3d_Structure)& theStructure, |
180 | const Aspect_TypeOfUpdate theUpdateMode); |
181 | |
182 | //! Erases the structure from the view. |
183 | Standard_EXPORT void Erase (const Handle(Graphic3d_Structure)& theStructure); |
184 | |
185 | //! Erases the structure from the view. |
186 | Standard_EXPORT void Erase (const Handle(Graphic3d_Structure)& theStructure, |
187 | const Aspect_TypeOfUpdate theUpdateMode); |
188 | |
189 | //! Highlights the structure in the view. |
8e5fb5ea |
190 | Standard_EXPORT void Highlight (const Handle(Graphic3d_Structure)& theStructure); |
c357e426 |
191 | |
192 | //! Transforms the structure in the view. |
193 | Standard_EXPORT void SetTransform (const Handle(Graphic3d_Structure)& theStructure, |
1f7f5a90 |
194 | const Handle(Geom_Transformation)& theTrsf); |
c357e426 |
195 | |
196 | //! Suppress the highlighting on the structure <AStructure> |
197 | //! in the view <me>. |
198 | Standard_EXPORT void UnHighlight (const Handle(Graphic3d_Structure)& theStructure); |
199 | |
200 | //! Returns an index != 0 if the structure have another structure computed for the view <me>. |
201 | Standard_EXPORT Standard_Integer IsComputed (const Handle(Graphic3d_Structure)& theStructure) const; |
202 | |
203 | //! Returns true if the structure is displayed in the view. |
204 | Standard_EXPORT Standard_Boolean IsDisplayed (const Handle(Graphic3d_Structure)& theStructure) const; |
205 | |
206 | //! Changes the display priority of the structure. |
207 | Standard_EXPORT void ChangePriority (const Handle(Graphic3d_Structure)& theStructure, |
208 | const Standard_Integer theOldPriority, |
209 | const Standard_Integer theNewPriority); |
210 | |
211 | //! Change Z layer of already displayed structure in the view. |
212 | Standard_EXPORT void ChangeZLayer (const Handle(Graphic3d_Structure)& theStructure, |
213 | const Graphic3d_ZLayerId theLayerId); |
214 | |
215 | //! Returns an index != 0 if the structure have the same owner than another structure |
216 | //! in the sequence of the computed structures. |
217 | Standard_EXPORT Standard_Integer HaveTheSameOwner (const Handle(Graphic3d_Structure)& theStructure) const; |
bf75be98 |
218 | |
219 | public: |
220 | |
c357e426 |
221 | //! Redraw content of the view. |
222 | virtual void Redraw() = 0; |
223 | |
224 | //! Redraw immediate content of the view. |
225 | virtual void RedrawImmediate() = 0; |
226 | |
227 | //! Invalidates content of the view but does not redraw it. |
228 | virtual void Invalidate() = 0; |
229 | |
230 | //! Return true if view content cache has been invalidated. |
231 | virtual Standard_Boolean IsInvalidated() = 0; |
232 | |
233 | //! Handle changing size of the rendering window. |
234 | virtual void Resized() = 0; |
235 | |
236 | //! @param theDrawToFrontBuffer Advanced option to modify rendering mode: |
237 | //! 1. TRUE. Drawing immediate mode structures directly to the front buffer over the scene image. |
238 | //! Fast, so preferred for interactive work (used by default). |
239 | //! However these extra drawings will be missed in image dump since it is performed from back buffer. |
240 | //! Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen |
241 | //! in run-time (in case of slow hardware) and/or tearing may appear. |
242 | //! So this is strongly recommended to draw only simple (fast) structures. |
243 | //! 2. FALSE. Drawing immediate mode structures to the back buffer. |
244 | //! The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync |
245 | //! is turned on. But it works in any case and is especially useful for view dump because the dump image is read |
246 | //! from the back buffer. |
247 | //! @return previous mode. |
248 | virtual Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer) = 0; |
249 | |
250 | //! Creates and maps rendering window to the view. |
c357e426 |
251 | //! @param theWindow [in] the window. |
252 | //! @param theContext [in] the rendering context. If NULL the context will be created internally. |
c357e426 |
253 | virtual void SetWindow (const Handle(Aspect_Window)& theWindow, |
a521d90d |
254 | const Aspect_RenderingContext theContext = NULL) = 0; |
c357e426 |
255 | |
256 | //! Returns the window associated to the view. |
257 | virtual Handle(Aspect_Window) Window() const = 0; |
258 | |
259 | //! Returns True if the window associated to the view is defined. |
260 | virtual Standard_Boolean IsDefined() const = 0; |
261 | |
c357e426 |
262 | //! Returns data of a graduated trihedron |
263 | virtual const Graphic3d_GraduatedTrihedron& GetGraduatedTrihedron() = 0; |
264 | |
265 | //! Displays Graduated Trihedron. |
266 | virtual void GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron& theTrihedronData) = 0; |
267 | |
268 | //! Erases Graduated Trihedron. |
269 | virtual void GraduatedTrihedronErase() = 0; |
270 | |
271 | //! Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object. |
272 | //! @param theMin [in] the minimum point of scene. |
273 | //! @param theMax [in] the maximum point of scene. |
274 | virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax) = 0; |
275 | |
c357e426 |
276 | //! Dump active rendering buffer into specified memory buffer. |
277 | virtual Standard_Boolean BufferDump (Image_PixMap& theImage, const Graphic3d_BufferType& theBufferType) = 0; |
278 | |
c357e426 |
279 | //! Export scene into the one of the Vector graphics formats (SVG, PS, PDF...). |
280 | //! In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits |
281 | //! on printing to laser printer). Notice however that results may differ a lot and |
282 | //! do not contain some elements. |
283 | virtual Standard_Boolean Export (const Standard_CString theFileName, |
284 | const Graphic3d_ExportFormat theFormat, |
285 | const Graphic3d_SortType theSortType = Graphic3d_ST_BSP_Tree) = 0; |
286 | |
287 | //! Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated. |
288 | virtual void InvalidateBVHData (const Standard_Integer theLayerId) = 0; |
289 | |
290 | //! Add a new top-level z layer with ID <theLayerId> for |
291 | //! the view. Z layers allow drawing structures in higher layers |
292 | //! in foreground of structures in lower layers. To add a structure |
293 | //! to desired layer on display it is necessary to set the layer |
294 | //! ID for the structure. |
295 | virtual void AddZLayer (const Graphic3d_ZLayerId theLayerId) = 0; |
296 | |
50d06d8f |
297 | //! Returns the maximum Z layer ID. |
298 | //! First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax(). |
299 | virtual Standard_Integer ZLayerMax() const = 0; |
300 | |
301 | //! Returns the bounding box of all structures displayed in the Z layer. |
302 | virtual void InvalidateZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId) const = 0; |
303 | |
304 | //! Returns the bounding box of all structures displayed in the Z layer. |
3fe9ce0e |
305 | //! @param theLayerId layer identifier |
306 | //! @param theCamera camera definition |
307 | //! @param theWindowWidth viewport width (for applying transformation-persistence) |
308 | //! @param theWindowHeight viewport height (for applying transformation-persistence) |
309 | //! @param theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence) |
310 | //! @return computed bounding box |
50d06d8f |
311 | virtual Graphic3d_BndBox4f ZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId, |
312 | const Handle(Graphic3d_Camera)& theCamera, |
313 | const Standard_Integer theWindowWidth, |
314 | const Standard_Integer theWindowHeight, |
3fe9ce0e |
315 | const Standard_Boolean theToIncludeAuxiliary) const = 0; |
50d06d8f |
316 | |
c357e426 |
317 | //! Remove Z layer from the specified view. All structures |
318 | //! displayed at the moment in layer will be displayed in default layer |
319 | //! ( the bottom-level z layer ). To unset layer ID from associated |
320 | //! structures use method UnsetZLayer (...). |
321 | virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId) = 0; |
322 | |
323 | //! Sets the settings for a single Z layer of specified view. |
324 | virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, |
325 | const Graphic3d_ZLayerSettings& theSettings) = 0; |
326 | |
50d06d8f |
327 | //! Returns zoom-scale factor. |
328 | Standard_EXPORT Standard_Real ConsiderZoomPersistenceObjects(); |
329 | |
c357e426 |
330 | //! Returns pointer to an assigned framebuffer object. |
b128c892 |
331 | virtual Handle(Standard_Transient) FBO() const = 0; |
c357e426 |
332 | |
333 | //! Sets framebuffer object for offscreen rendering. |
b128c892 |
334 | virtual void SetFBO (const Handle(Standard_Transient)& theFbo) = 0; |
c357e426 |
335 | |
336 | //! Generate offscreen FBO in the graphic library. |
337 | //! If not supported on hardware returns NULL. |
b128c892 |
338 | virtual Handle(Standard_Transient) FBOCreate (const Standard_Integer theWidth, |
339 | const Standard_Integer theHeight) = 0; |
c357e426 |
340 | |
341 | //! Remove offscreen FBO from the graphic library |
b128c892 |
342 | virtual void FBORelease (Handle(Standard_Transient)& theFbo) = 0; |
c357e426 |
343 | |
344 | //! Read offscreen FBO configuration. |
b128c892 |
345 | virtual void FBOGetDimensions (const Handle(Standard_Transient)& theFbo, |
c357e426 |
346 | Standard_Integer& theWidth, |
347 | Standard_Integer& theHeight, |
348 | Standard_Integer& theWidthMax, |
349 | Standard_Integer& theHeightMax) = 0; |
350 | |
351 | //! Change offscreen FBO viewport. |
b128c892 |
352 | virtual void FBOChangeViewport (const Handle(Standard_Transient)& theFbo, |
c357e426 |
353 | const Standard_Integer theWidth, |
354 | const Standard_Integer theHeight) = 0; |
bf75be98 |
355 | |
356 | public: |
357 | |
c357e426 |
358 | //! Copy visualization settings from another view. |
359 | //! Method is used for cloning views in viewer when its required to create view |
360 | //! with same view properties. |
361 | Standard_EXPORT virtual void CopySettings (const Handle(Graphic3d_CView)& theOther); |
362 | |
363 | //! Returns current rendering parameters and effect settings. |
364 | const Graphic3d_RenderingParams& RenderingParams() const { return myRenderParams; } |
365 | |
366 | //! Returns reference to current rendering parameters and effect settings. |
367 | Graphic3d_RenderingParams& ChangeRenderingParams() { return myRenderParams; } |
368 | |
c357e426 |
369 | //! Returns background fill color. |
370 | virtual Aspect_Background Background() const = 0; |
371 | |
372 | //! Sets background fill color. |
373 | virtual void SetBackground (const Aspect_Background& theBackground) = 0; |
374 | |
375 | //! Returns gradient background fill colors. |
376 | virtual Aspect_GradientBackground GradientBackground() const = 0; |
377 | |
378 | //! Sets gradient background fill colors. |
379 | virtual void SetGradientBackground (const Aspect_GradientBackground& theBackground) = 0; |
380 | |
381 | //! Returns background image texture file path. |
382 | virtual TCollection_AsciiString BackgroundImage() = 0; |
383 | |
384 | //! Sets background image texture file path. |
385 | virtual void SetBackgroundImage (const TCollection_AsciiString& theFilePath) = 0; |
386 | |
387 | //! Returns background image fill style. |
388 | virtual Aspect_FillMethod BackgroundImageStyle() const = 0; |
389 | |
390 | //! Sets background image fill style. |
391 | virtual void SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle) = 0; |
392 | |
393 | //! Returns environment texture set for the view. |
394 | virtual Handle(Graphic3d_TextureEnv) TextureEnv() const = 0; |
395 | |
396 | //! Sets environment texture for the view. |
397 | virtual void SetTextureEnv (const Handle(Graphic3d_TextureEnv)& theTextureEnv) = 0; |
398 | |
399 | //! Returns the state of frustum culling optimization. |
400 | virtual Standard_Boolean IsCullingEnabled() const = 0; |
401 | |
402 | //! Enables or disables frustum culling optimization. |
403 | virtual void SetCullingEnabled (const Standard_Boolean theIsEnabled) = 0; |
404 | |
405 | //! Returns shading model of the view. |
406 | virtual Graphic3d_TypeOfShadingModel ShadingModel() const = 0; |
407 | |
408 | //! Sets shading model of the view. |
409 | virtual void SetShadingModel (const Graphic3d_TypeOfShadingModel theModel) = 0; |
410 | |
c357e426 |
411 | //! Return backfacing model used for the view. |
412 | virtual Graphic3d_TypeOfBackfacingModel BackfacingModel() const = 0; |
bf75be98 |
413 | |
c357e426 |
414 | //! Sets backfacing model for the view. |
415 | virtual void SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel) = 0; |
bf75be98 |
416 | |
c357e426 |
417 | //! Returns camera object of the view. |
418 | virtual const Handle(Graphic3d_Camera)& Camera() const = 0; |
bf75be98 |
419 | |
c357e426 |
420 | //! Sets camera used by the view. |
421 | virtual void SetCamera (const Handle(Graphic3d_Camera)& theCamera) = 0; |
bf75be98 |
422 | |
c357e426 |
423 | //! Returns list of lights of the view. |
424 | virtual const Graphic3d_ListOfCLight& Lights() const = 0; |
425 | |
426 | //! Sets list of lights for the view. |
427 | virtual void SetLights (const Graphic3d_ListOfCLight& theLights) = 0; |
428 | |
429 | //! Returns list of clip planes set for the view. |
3202bf1e |
430 | virtual const Handle(Graphic3d_SequenceOfHClipPlane)& ClipPlanes() const = 0; |
c357e426 |
431 | |
432 | //! Sets list of clip planes for the view. |
3202bf1e |
433 | virtual void SetClipPlanes (const Handle(Graphic3d_SequenceOfHClipPlane)& thePlanes) = 0; |
c357e426 |
434 | |
26d9c835 |
435 | //! Fill in the dictionary with diagnostic info. |
436 | //! Should be called within rendering thread. |
437 | //! |
438 | //! This API should be used only for user output or for creating automated reports. |
439 | //! The format of returned information (e.g. key-value layout) |
440 | //! is NOT part of this API and can be changed at any time. |
441 | //! Thus application should not parse returned information to weed out specific parameters. |
442 | virtual void DiagnosticInformation (TColStd_IndexedDataMapOfStringString& theDict, |
443 | Graphic3d_DiagnosticInfo theFlags) const = 0; |
444 | |
c357e426 |
445 | private: |
446 | |
447 | //! Adds the structure to display lists of the view. |
448 | virtual void displayStructure (const Handle(Graphic3d_CStructure)& theStructure, |
449 | const Standard_Integer thePriority) = 0; |
450 | |
451 | //! Erases the structure from display lists of the view. |
452 | virtual void eraseStructure (const Handle(Graphic3d_CStructure)& theStructure) = 0; |
453 | |
454 | //! Change Z layer of a structure already presented in view. |
455 | virtual void changeZLayer (const Handle(Graphic3d_CStructure)& theCStructure, |
456 | const Graphic3d_ZLayerId theNewLayerId) = 0; |
457 | |
458 | //! Changes the priority of a structure within its Z layer in the specified view. |
459 | virtual void changePriority (const Handle(Graphic3d_CStructure)& theCStructure, |
460 | const Standard_Integer theNewPriority) = 0; |
461 | |
50d06d8f |
462 | //! Returns zoom-scale factor. |
463 | virtual Standard_Real considerZoomPersistenceObjects (const Graphic3d_ZLayerId theLayerId, |
464 | const Handle(Graphic3d_Camera)& theCamera, |
465 | const Standard_Integer theWindowWidth, |
3fe9ce0e |
466 | const Standard_Integer theWindowHeight) const = 0; |
c357e426 |
467 | |
468 | protected: |
469 | |
470 | Standard_Integer myId; |
471 | Graphic3d_RenderingParams myRenderParams; |
472 | Handle(Graphic3d_StructureManager) myStructureManager; |
473 | Graphic3d_SequenceOfStructure myStructsToCompute; |
474 | Graphic3d_SequenceOfStructure myStructsComputed; |
475 | Graphic3d_MapOfStructure myStructsDisplayed; |
476 | Handle(Graphic3d_NMapOfTransient) myHiddenObjects; |
477 | Standard_Boolean myIsInComputedMode; |
478 | Standard_Boolean myIsActive; |
479 | Standard_Boolean myIsRemoved; |
480 | Graphic3d_TypeOfVisualization myVisualization; |
c357e426 |
481 | |
482 | private: |
483 | |
92efcf78 |
484 | DEFINE_STANDARD_RTTIEXT(Graphic3d_CView,Graphic3d_DataStructureManager) |
bf75be98 |
485 | }; |
486 | |
c357e426 |
487 | #endif // _Graphic3d_CView_HeaderFile |