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