VTK  9.1.0
vtkLODProp3D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkLODProp3D.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
33 #ifndef vtkLODProp3D_h
34 #define vtkLODProp3D_h
35 
36 #include "vtkProp3D.h"
37 #include "vtkRenderingCoreModule.h" // For export macro
38 
39 class vtkRenderer;
40 class vtkMapper;
43 class vtkImageMapper3D;
44 class vtkProperty;
45 class vtkVolumeProperty;
46 class vtkImageProperty;
47 class vtkTexture;
48 class vtkLODProp3DCallback;
49 
51 {
54  int ID;
55  double EstimatedTime;
56  int State;
57  double Level;
58 };
60 
61 class VTKRENDERINGCORE_EXPORT vtkLODProp3D : public vtkProp3D
62 {
63 public:
67  static vtkLODProp3D* New();
68 
69  vtkTypeMacro(vtkLODProp3D, vtkProp3D);
70  void PrintSelf(ostream& os, vtkIndent indent) override;
71 
75  double* GetBounds() VTK_SIZEHINT(6) override;
76  void GetBounds(double bounds[6]) { this->vtkProp3D::GetBounds(bounds); }
77 
79 
88  int AddLOD(vtkMapper* m, vtkProperty* p, vtkProperty* back, vtkTexture* t, double time);
89  int AddLOD(vtkMapper* m, vtkProperty* p, vtkTexture* t, double time);
90  int AddLOD(vtkMapper* m, vtkProperty* p, vtkProperty* back, double time);
91  int AddLOD(vtkMapper* m, vtkProperty* p, double time);
92  int AddLOD(vtkMapper* m, vtkTexture* t, double time);
93  int AddLOD(vtkMapper* m, double time);
97  int AddLOD(vtkImageMapper3D* m, double time);
99 
101 
104  vtkGetMacro(NumberOfLODs, int);
106 
108 
113  vtkGetMacro(CurrentIndex, int);
115 
120  void RemoveLOD(int id);
121 
123 
129  void SetLODProperty(int id, vtkProperty* p);
130  void GetLODProperty(int id, vtkProperty** p);
134  void GetLODProperty(int id, vtkImageProperty** p);
136 
138 
144  void SetLODMapper(int id, vtkMapper* m);
145  void GetLODMapper(int id, vtkMapper** m);
148  void SetLODMapper(int id, vtkImageMapper3D* m);
149  void GetLODMapper(int id, vtkImageMapper3D** m);
151 
158 
160 
167 
169 
173  void SetLODTexture(int id, vtkTexture* t);
174  void GetLODTexture(int id, vtkTexture** t);
176 
178 
183  void EnableLOD(int id);
184  void DisableLOD(int id);
185  int IsLODEnabled(int id);
187 
189 
197  void SetLODLevel(int id, double level);
198  double GetLODLevel(int id);
199  double GetLODIndexLevel(int index);
201 
203 
211 
213 
218  vtkSetClampMacro(AutomaticLODSelection, vtkTypeBool, 0, 1);
219  vtkGetMacro(AutomaticLODSelection, vtkTypeBool);
220  vtkBooleanMacro(AutomaticLODSelection, vtkTypeBool);
222 
224 
228  vtkSetMacro(SelectedLODID, int);
229  vtkGetMacro(SelectedLODID, int);
231 
236 
240  int GetPickLODID(void);
241 
243 
248  void GetActors(vtkPropCollection*) override;
249  void GetVolumes(vtkPropCollection*) override;
251 
253 
257  void SetSelectedPickLODID(int id);
258  vtkGetMacro(SelectedPickLODID, int);
260 
262 
267  vtkSetClampMacro(AutomaticPickLODSelection, vtkTypeBool, 0, 1);
268  vtkGetMacro(AutomaticPickLODSelection, vtkTypeBool);
269  vtkBooleanMacro(AutomaticPickLODSelection, vtkTypeBool);
271 
275  void ShallowCopy(vtkProp* prop) override;
276 
278 
281  int RenderOpaqueGeometry(vtkViewport* viewport) override;
283  int RenderVolumetricGeometry(vtkViewport* viewport) override;
285 
290 
297 
303  void SetAllocatedRenderTime(double t, vtkViewport* vp) override;
304 
311  void RestoreEstimatedRenderTime() override;
312 
317  void AddEstimatedRenderTime(double t, vtkViewport* vp) override;
318 
319 protected:
321  ~vtkLODProp3D() override;
322 
324 
325  // Assumes that SelectedLODIndex has already been validated:
327 
332 
334  int ConvertIDToIndex(int id);
336 
341  vtkLODProp3DCallback* PickCallback;
342 
343 private:
344  vtkLODProp3D(const vtkLODProp3D&) = delete;
345  void operator=(const vtkLODProp3D&) = delete;
346 };
347 
348 #endif
abstract class specifies interface to map 3D data
Abstract class for a volume mapper.
abstract class for mapping images to the screen
image display properties
a simple class to control print indentation
Definition: vtkIndent.h:34
level of detail 3D prop
Definition: vtkLODProp3D.h:62
void GetLODMapper(int id, vtkImageMapper3D **m)
Methods to set / get the mapper of an LOD.
int RenderOpaqueGeometry(vtkViewport *viewport) override
Support the standard render methods.
void SetLODMapper(int id, vtkMapper *m)
Methods to set / get the mapper of an LOD.
double * GetBounds() override
Standard vtkProp method to get 3D bounds of a 3D prop.
int GetAutomaticPickPropIndex(void)
void GetActors(vtkPropCollection *) override
For some exporters and other other operations we must be able to collect all the actors or volumes.
void RestoreEstimatedRenderTime() override
Used when the render process is aborted to restore the previous estimated render time.
void GetVolumes(vtkPropCollection *) override
For some exporters and other other operations we must be able to collect all the actors or volumes.
void SetLODProperty(int id, vtkImageProperty *p)
Methods to set / get the property of an LOD.
void SetSelectedPickLODID(int id)
Set the id of the LOD that is to be used for picking when automatic LOD pick selection is turned off.
vtkTypeBool AutomaticLODSelection
Definition: vtkLODProp3D.h:337
static vtkLODProp3D * New()
Create an instance of this class.
vtkLODProp3DEntry * LODs
Definition: vtkLODProp3D.h:328
int IsLODEnabled(int id)
Enable / disable a particular LOD.
double GetLODLevel(int id)
Set the level of a particular LOD.
int GetLastRenderedLODID()
Get the ID of the previously (during the last render) selected LOD index.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int SelectedPickLODID
Definition: vtkLODProp3D.h:339
int GetNextEntryIndex()
vtkLODProp3DCallback * PickCallback
Definition: vtkLODProp3D.h:341
int AddLOD(vtkAbstractVolumeMapper *m, vtkVolumeProperty *p, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
void SetLODProperty(int id, vtkProperty *p)
Methods to set / get the property of an LOD.
int SelectedLODIndex
Definition: vtkLODProp3D.h:335
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkLODProp3D.
int RenderVolumetricGeometry(vtkViewport *viewport) override
Support the standard render methods.
vtkTypeBool AutomaticPickLODSelection
Definition: vtkLODProp3D.h:340
void RemoveLOD(int id)
Delete a level of detail given an ID.
double GetLODIndexEstimatedRenderTime(int index)
Access method that can be used to find out the estimated render time (the thing used to select an LOD...
int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override
Support the standard render methods.
void GetLODMapper(int id, vtkMapper **m)
Methods to set / get the mapper of an LOD.
double GetLODIndexLevel(int index)
Set the level of a particular LOD.
void GetLODProperty(int id, vtkProperty **p)
Methods to set / get the property of an LOD.
void GetLODTexture(int id, vtkTexture **t)
Methods to set / get the texture of an LOD.
vtkAbstractMapper3D * GetLODMapper(int id)
Get the LODMapper as an vtkAbstractMapper3D.
void SetLODLevel(int id, double level)
Set the level of a particular LOD.
double GetLODEstimatedRenderTime(int id)
Access method that can be used to find out the estimated render time (the thing used to select an LOD...
void EnableLOD(int id)
Enable / disable a particular LOD.
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
void GetLODBackfaceProperty(int id, vtkProperty **t)
Methods to set / get the backface property of an LOD.
int ConvertIDToIndex(int id)
void SetLODMapper(int id, vtkImageMapper3D *m)
Methods to set / get the mapper of an LOD.
int AddLOD(vtkMapper *m, vtkProperty *p, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
void SetLODBackfaceProperty(int id, vtkProperty *t)
Methods to set / get the backface property of an LOD.
int AddLOD(vtkImageMapper3D *m, vtkImageProperty *p, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
int AddLOD(vtkAbstractVolumeMapper *m, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
int AddLOD(vtkMapper *m, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
void SetAllocatedRenderTime(double t, vtkViewport *vp) override
Used by the culler / renderer to set the allocated render time for this prop.
void GetLODProperty(int id, vtkImageProperty **p)
Methods to set / get the property of an LOD.
void DisableLOD(int id)
Enable / disable a particular LOD.
int AddLOD(vtkImageMapper3D *m, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
void UpdateKeysForSelectedProp()
int AddLOD(vtkMapper *m, vtkProperty *p, vtkProperty *back, vtkTexture *t, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
void SetLODMapper(int id, vtkAbstractVolumeMapper *m)
Methods to set / get the mapper of an LOD.
int AddLOD(vtkMapper *m, vtkProperty *p, vtkProperty *back, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
int GetPickLODID(void)
Get the ID of the appropriate pick LOD index.
int AddLOD(vtkMapper *m, vtkProperty *p, vtkTexture *t, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
void GetLODProperty(int id, vtkVolumeProperty **p)
Methods to set / get the property of an LOD.
void SetLODProperty(int id, vtkVolumeProperty *p)
Methods to set / get the property of an LOD.
void SetLODTexture(int id, vtkTexture *t)
Methods to set / get the texture of an LOD.
~vtkLODProp3D() override
void GetLODMapper(int id, vtkAbstractVolumeMapper **m)
Methods to set / get the mapper of an LOD.
void AddEstimatedRenderTime(double t, vtkViewport *vp) override
Override method from vtkProp in order to push this call down to the selected LOD as well.
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
int AddLOD(vtkMapper *m, vtkTexture *t, double time)
Add a level of detail with a given mapper, property, backface property, texture, and guess of renderi...
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:82
represents an 3D object for placement in a rendered scene
Definition: vtkProp3D.h:44
double * GetBounds() override=0
Return a reference to the Prop3D's composite transform.
an ordered list of Props
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:57
represent surface properties of a geometric object
Definition: vtkProperty.h:62
abstract specification for renderers
Definition: vtkRenderer.h:73
handles properties associated with a texture map
Definition: vtkTexture.h:66
abstract specification for Viewports
Definition: vtkViewport.h:47
represents the common properties for rendering a volume.
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
void GetBounds(T a, double bds[6])
@ level
Definition: vtkX3D.h:401
@ time
Definition: vtkX3D.h:503
@ index
Definition: vtkX3D.h:252
vtkProp3D * Prop3D
Definition: vtkLODProp3D.h:52
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)