VTK  9.3.20240424
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
40#ifndef vtkLODProp3D_h
41#define vtkLODProp3D_h
42
43#include "vtkProp3D.h"
44#include "vtkRenderingCoreModule.h" // For export macro
45
46VTK_ABI_NAMESPACE_BEGIN
47class vtkRenderer;
48class vtkMapper;
52class vtkProperty;
55class vtkTexture;
56class vtkLODProp3DCallback;
57
59{
62 int ID;
64 int State;
65 double Level;
66};
68
69class VTKRENDERINGCORE_EXPORT vtkLODProp3D : public vtkProp3D
70{
71public:
75 static vtkLODProp3D* New();
76
77 vtkTypeMacro(vtkLODProp3D, vtkProp3D);
78 void PrintSelf(ostream& os, vtkIndent indent) override;
79
83 double* GetBounds() VTK_SIZEHINT(6) override;
84 void GetBounds(double bounds[6]) { this->vtkProp3D::GetBounds(bounds); }
85
87
96 int AddLOD(vtkMapper* m, vtkProperty* p, vtkProperty* back, vtkTexture* t, double time);
97 int AddLOD(vtkMapper* m, vtkProperty* p, vtkTexture* t, double time);
98 int AddLOD(vtkMapper* m, vtkProperty* p, vtkProperty* back, double time);
99 int AddLOD(vtkMapper* m, vtkProperty* p, double time);
100 int AddLOD(vtkMapper* m, vtkTexture* t, double time);
101 int AddLOD(vtkMapper* m, double time);
103 int AddLOD(vtkAbstractVolumeMapper* m, double time);
104 int AddLOD(vtkImageMapper3D* m, vtkImageProperty* p, double time);
105 int AddLOD(vtkImageMapper3D* m, double time);
107
109
112 vtkGetMacro(NumberOfLODs, int);
114
116
121 vtkGetMacro(CurrentIndex, int);
123
128 void RemoveLOD(int id);
129
131
137 void SetLODProperty(int id, vtkProperty* p);
138 void GetLODProperty(int id, vtkProperty** p);
144
146
152 void SetLODMapper(int id, vtkMapper* m);
153 void GetLODMapper(int id, vtkMapper** m);
159
166
168
175
177
181 void SetLODTexture(int id, vtkTexture* t);
182 void GetLODTexture(int id, vtkTexture** t);
184
186
191 void EnableLOD(int id);
192 void DisableLOD(int id);
193 int IsLODEnabled(int id);
195
197
205 void SetLODLevel(int id, double level);
206 double GetLODLevel(int id);
207 double GetLODIndexLevel(int index);
209
211
219
221
226 vtkSetClampMacro(AutomaticLODSelection, vtkTypeBool, 0, 1);
227 vtkGetMacro(AutomaticLODSelection, vtkTypeBool);
228 vtkBooleanMacro(AutomaticLODSelection, vtkTypeBool);
230
232
236 vtkSetMacro(SelectedLODID, int);
237 vtkGetMacro(SelectedLODID, int);
239
244
249
251
259
261
266 vtkGetMacro(SelectedPickLODID, int);
268
270
275 vtkSetClampMacro(AutomaticPickLODSelection, vtkTypeBool, 0, 1);
276 vtkGetMacro(AutomaticPickLODSelection, vtkTypeBool);
277 vtkBooleanMacro(AutomaticPickLODSelection, vtkTypeBool);
279
283 void ShallowCopy(vtkProp* prop) override;
284
286
289 int RenderOpaqueGeometry(vtkViewport* viewport) override;
291 int RenderVolumetricGeometry(vtkViewport* viewport) override;
293
298
305
311 void SetAllocatedRenderTime(double t, vtkViewport* vp) override;
312
320
325 void AddEstimatedRenderTime(double t, vtkViewport* vp) override;
326
327protected:
329 ~vtkLODProp3D() override;
330
332
333 // Assumes that SelectedLODIndex has already been validated:
335
340
342 int ConvertIDToIndex(int id);
344
349 vtkLODProp3DCallback* PickCallback;
350
351private:
352 vtkLODProp3D(const vtkLODProp3D&) = delete;
353 void operator=(const vtkLODProp3D&) = delete;
354};
355
356VTK_ABI_NAMESPACE_END
357#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:108
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:137
represents an 3D object for placement in a rendered scene
Definition vtkProp3D.h:89
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:66
represent surface properties of a geometric object
abstract specification for renderers
handles properties associated with a texture map
Definition vtkTexture.h:167
abstract specification for Viewports
Definition vtkViewport.h:65
represents the common properties for rendering a volume.
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_SIZEHINT(...)