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