VTK  9.3.0
vtkLODProp3D.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
18#ifndef vtkLODProp3D_h
19#define vtkLODProp3D_h
20
21#include "vtkProp3D.h"
22#include "vtkRenderingCoreModule.h" // For export macro
23
24VTK_ABI_NAMESPACE_BEGIN
25class vtkRenderer;
26class vtkMapper;
30class vtkProperty;
33class vtkTexture;
34class vtkLODProp3DCallback;
35
37{
40 int ID;
42 int State;
43 double Level;
44};
46
47class VTKRENDERINGCORE_EXPORT vtkLODProp3D : public vtkProp3D
48{
49public:
53 static vtkLODProp3D* New();
54
55 vtkTypeMacro(vtkLODProp3D, vtkProp3D);
56 void PrintSelf(ostream& os, vtkIndent indent) override;
57
61 double* GetBounds() VTK_SIZEHINT(6) override;
62 void GetBounds(double bounds[6]) { this->vtkProp3D::GetBounds(bounds); }
63
65
74 int AddLOD(vtkMapper* m, vtkProperty* p, vtkProperty* back, vtkTexture* t, double time);
75 int AddLOD(vtkMapper* m, vtkProperty* p, vtkTexture* t, double time);
76 int AddLOD(vtkMapper* m, vtkProperty* p, vtkProperty* back, double time);
77 int AddLOD(vtkMapper* m, vtkProperty* p, double time);
78 int AddLOD(vtkMapper* m, vtkTexture* t, double time);
79 int AddLOD(vtkMapper* m, double time);
81 int AddLOD(vtkAbstractVolumeMapper* m, double time);
82 int AddLOD(vtkImageMapper3D* m, vtkImageProperty* p, double time);
83 int AddLOD(vtkImageMapper3D* m, double time);
85
87
90 vtkGetMacro(NumberOfLODs, int);
92
94
99 vtkGetMacro(CurrentIndex, int);
101
106 void RemoveLOD(int id);
107
109
115 void SetLODProperty(int id, vtkProperty* p);
116 void GetLODProperty(int id, vtkProperty** p);
122
124
130 void SetLODMapper(int id, vtkMapper* m);
131 void GetLODMapper(int id, vtkMapper** m);
137
144
146
153
155
159 void SetLODTexture(int id, vtkTexture* t);
160 void GetLODTexture(int id, vtkTexture** t);
162
164
169 void EnableLOD(int id);
170 void DisableLOD(int id);
171 int IsLODEnabled(int id);
173
175
183 void SetLODLevel(int id, double level);
184 double GetLODLevel(int id);
185 double GetLODIndexLevel(int index);
187
189
197
199
204 vtkSetClampMacro(AutomaticLODSelection, vtkTypeBool, 0, 1);
205 vtkGetMacro(AutomaticLODSelection, vtkTypeBool);
206 vtkBooleanMacro(AutomaticLODSelection, vtkTypeBool);
208
210
214 vtkSetMacro(SelectedLODID, int);
215 vtkGetMacro(SelectedLODID, int);
217
222
227
229
237
239
244 vtkGetMacro(SelectedPickLODID, int);
246
248
253 vtkSetClampMacro(AutomaticPickLODSelection, vtkTypeBool, 0, 1);
254 vtkGetMacro(AutomaticPickLODSelection, vtkTypeBool);
255 vtkBooleanMacro(AutomaticPickLODSelection, vtkTypeBool);
257
261 void ShallowCopy(vtkProp* prop) override;
262
264
267 int RenderOpaqueGeometry(vtkViewport* viewport) override;
269 int RenderVolumetricGeometry(vtkViewport* viewport) override;
271
276
283
289 void SetAllocatedRenderTime(double t, vtkViewport* vp) override;
290
298
303 void AddEstimatedRenderTime(double t, vtkViewport* vp) override;
304
305protected:
307 ~vtkLODProp3D() override;
308
310
311 // Assumes that SelectedLODIndex has already been validated:
313
318
320 int ConvertIDToIndex(int id);
322
327 vtkLODProp3DCallback* PickCallback;
328
329private:
330 vtkLODProp3D(const vtkLODProp3D&) = delete;
331 void operator=(const vtkLODProp3D&) = delete;
332};
333
334VTK_ABI_NAMESPACE_END
335#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:29
level of detail 3D prop
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.
int GetAutomaticPickPropIndex()
void SetLODMapper(int id, vtkMapper *m)
Methods to set / get the mapper of an LOD.
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
vtkLODProp3DEntry * LODs
int IsLODEnabled(int id)
Enable / disable a particular LOD.
double GetLODLevel(int id)
Set the level of a particular LOD.
vtkAbstractMapper3D * GetLODMapper(int id)
Get the LODMapper as an vtkAbstractMapper3D.
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 GetNextEntryIndex()
vtkLODProp3DCallback * PickCallback
static vtkLODProp3D * New()
Create an instance of this class.
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...
double * GetBounds() override
Standard vtkProp method to get 3D bounds of a 3D prop.
void SetLODProperty(int id, vtkProperty *p)
Methods to set / get the property of an LOD.
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkLODProp3D.
int RenderVolumetricGeometry(vtkViewport *viewport) override
Support the standard render methods.
vtkTypeBool AutomaticPickLODSelection
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.
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 GetPickLODID()
Get the ID of the appropriate pick LOD index.
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 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:77
represents an 3D object for placement in a rendered scene
Definition vtkProp3D.h:39
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:43
represent surface properties of a geometric object
Definition vtkProperty.h:57
abstract specification for renderers
Definition vtkRenderer.h:59
handles properties associated with a texture map
Definition vtkTexture.h:58
abstract specification for Viewports
Definition vtkViewport.h:45
represents the common properties for rendering a volume.
window superclass for vtkRenderWindow
Definition vtkWindow.h:25
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_SIZEHINT(...)