VTK  9.2.6
vtkProp.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkProp.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=========================================================================*/
37#ifndef vtkProp_h
38#define vtkProp_h
39
40#include "vtkObject.h"
41#include "vtkRenderingCoreModule.h" // For export macro
42#include <vector> // for method args
43
44class vtkAssemblyPath;
47class vtkMatrix4x4;
49class vtkViewport;
50class vtkWindow;
51class vtkInformation;
55
56class VTKRENDERINGCORE_EXPORT vtkProp : public vtkObject
57{
58public:
59 vtkTypeMacro(vtkProp, vtkObject);
60 void PrintSelf(ostream& os, vtkIndent indent) override;
61
67 virtual void GetActors(vtkPropCollection*) {}
69 virtual void GetVolumes(vtkPropCollection*) {}
70
72
75 vtkSetMacro(Visibility, vtkTypeBool);
76 vtkGetMacro(Visibility, vtkTypeBool);
77 vtkBooleanMacro(Visibility, vtkTypeBool);
79
81
86 vtkSetMacro(Pickable, vtkTypeBool);
87 vtkGetMacro(Pickable, vtkTypeBool);
88 vtkBooleanMacro(Pickable, vtkTypeBool);
90
94 virtual void Pick();
95
97
106 vtkSetMacro(Dragable, vtkTypeBool);
107 vtkGetMacro(Dragable, vtkTypeBool);
108 vtkBooleanMacro(Dragable, vtkTypeBool);
110
117 virtual vtkMTimeType GetRedrawMTime() { return this->GetMTime(); }
118
120
126 vtkSetMacro(UseBounds, bool);
127 vtkGetMacro(UseBounds, bool);
128 vtkBooleanMacro(UseBounds, bool);
130
135 virtual double* GetBounds() VTK_SIZEHINT(6) { return nullptr; }
136
140 virtual void ShallowCopy(vtkProp* prop);
141
143
155 virtual void InitPathTraversal();
157 virtual int GetNumberOfPaths() { return 1; }
159
165 virtual void PokeMatrix(vtkMatrix4x4* vtkNotUsed(matrix)) {}
166 virtual vtkMatrix4x4* GetMatrix() { return nullptr; }
167
169
176 vtkGetObjectMacro(PropertyKeys, vtkInformation);
177 virtual void SetPropertyKeys(vtkInformation* keys);
179
184 virtual bool HasKeys(vtkInformation* requiredKeys);
185
196
207
224 virtual int RenderOpaqueGeometry(vtkViewport*) { return 0; }
226 virtual int RenderVolumetricGeometry(vtkViewport*) { return 0; }
227 virtual int RenderOverlay(vtkViewport*) { return 0; }
228
239
251 vtkViewport* v, vtkInformation* requiredKeys);
252
264
275 virtual bool RenderFilteredOverlay(vtkViewport* v, vtkInformation* requiredKeys);
276
289
301 virtual vtkTypeBool HasOpaqueGeometry() { return 1; }
302
310
323 virtual double GetEstimatedRenderTime(vtkViewport*) { return this->EstimatedRenderTime; }
324 virtual double GetEstimatedRenderTime() { return this->EstimatedRenderTime; }
325
333 virtual void SetEstimatedRenderTime(double t)
334 {
335 this->EstimatedRenderTime = t;
336 this->SavedEstimatedRenderTime = t;
337 }
338
348 {
349 this->EstimatedRenderTime = this->SavedEstimatedRenderTime;
350 }
351
365 virtual void AddEstimatedRenderTime(double t, vtkViewport* vtkNotUsed(vp))
366 {
367 this->EstimatedRenderTime += t;
368 }
369
371
381 virtual void SetAllocatedRenderTime(double t, vtkViewport* vtkNotUsed(v))
382 {
383 this->AllocatedRenderTime = t;
384 this->SavedEstimatedRenderTime = this->EstimatedRenderTime;
385 this->EstimatedRenderTime = 0.0;
386 }
388
390
394 vtkGetMacro(AllocatedRenderTime, double);
396
404 void SetRenderTimeMultiplier(double t) { this->RenderTimeMultiplier = t; }
405 vtkGetMacro(RenderTimeMultiplier, double);
406
412 virtual void BuildPaths(vtkAssemblyPaths* paths, vtkAssemblyPath* path);
413
420 virtual bool GetSupportsSelection() { return false; }
421
427 vtkHardwareSelector* /* sel */, std::vector<unsigned int>& /* pixeloffsets */)
428 {
429 }
430
432
435 vtkGetMacro(NumberOfConsumers, int);
437
439
447
449
452 virtual void SetShaderProperty(vtkShaderProperty* property);
455
457 // Get if we are in the translucent polygonal geometry pass
458 virtual bool IsRenderingTranslucentPolygonalGeometry() { return false; }
460
461protected:
463 ~vtkProp() override;
464
469
474
475 // how many consumers does this object have
478
479 // support multi-part props and access to paths of prop
480 // stuff that follows is used to build the assembly hierarchy
482
484
485 // User-defined shader replacement and uniform variables
487
488private:
489 vtkProp(const vtkProp&) = delete;
490 void operator=(const vtkProp&) = delete;
491};
492
493#endif
a list of nodes that form an assembly path
a list of lists of props representing an assembly hierarchy
a simple class to control print indentation
Definition vtkIndent.h:40
Key for integer values in vtkInformation.
Store vtkAlgorithm input/output information.
represent and manipulate 4x4 transformation matrices
abstract base class for most VTK objects
Definition vtkObject.h:63
virtual vtkMTimeType GetMTime()
Return this object's modified time.
an ordered list of Props
abstract superclass for all actors, volumes and annotations
Definition vtkProp.h:57
virtual void PokeMatrix(vtkMatrix4x4 *vtkNotUsed(matrix))
These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
Definition vtkProp.h:165
virtual void ProcessSelectorPixelBuffers(vtkHardwareSelector *, std::vector< unsigned int > &)
allows a prop to update a selections color buffers
Definition vtkProp.h:426
static vtkInformationDoubleVectorKey * GeneralTextureTransform()
Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state mach...
virtual vtkTypeBool HasOpaqueGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:301
virtual void BuildPaths(vtkAssemblyPaths *paths, vtkAssemblyPath *path)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
virtual vtkShaderProperty * GetShaderProperty()
Set/Get the shader property.
virtual bool RenderFilteredTranslucentPolygonalGeometry(vtkViewport *v, vtkInformation *requiredKeys)
Render the translucent polygonal geometry only if the prop has all the requiredKeys.
virtual double GetEstimatedRenderTime()
Definition vtkProp.h:324
virtual bool RenderFilteredOverlay(vtkViewport *v, vtkInformation *requiredKeys)
Render in the overlay of the viewport only if the prop has all the requiredKeys.
vtkObject ** Consumers
Definition vtkProp.h:477
virtual bool RenderFilteredVolumetricGeometry(vtkViewport *v, vtkInformation *requiredKeys)
Render the volumetric geometry only if the prop has all the requiredKeys.
~vtkProp() override
vtkAssemblyPaths * Paths
Definition vtkProp.h:481
void SetRenderTimeMultiplier(double t)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:404
virtual int GetNumberOfPaths()
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g.,...
Definition vtkProp.h:157
virtual void SetEstimatedRenderTime(double t)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:333
virtual int RenderOpaqueGeometry(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:224
virtual void Pick()
Method fires PickEvent if the prop is picked.
vtkInformation * PropertyKeys
Definition vtkProp.h:483
bool UseBounds
Definition vtkProp.h:468
vtkTypeBool Pickable
Definition vtkProp.h:466
virtual void AddEstimatedRenderTime(double t, vtkViewport *vtkNotUsed(vp))
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:365
virtual bool GetSupportsSelection()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:420
virtual vtkAssemblyPath * GetNextPath()
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g.,...
int NumberOfConsumers
Definition vtkProp.h:476
void RemoveConsumer(vtkObject *c)
Add or remove or get or check a consumer,.
double SavedEstimatedRenderTime
Definition vtkProp.h:472
virtual vtkTypeBool HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:288
vtkTypeBool Dragable
Definition vtkProp.h:467
virtual void InitPathTraversal()
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g.,...
vtkObject * GetConsumer(int i)
Add or remove or get or check a consumer,.
int IsConsumer(vtkObject *c)
Add or remove or get or check a consumer,.
static vtkInformationIntegerKey * GeneralTextureUnit()
Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine w...
double EstimatedRenderTime
Definition vtkProp.h:471
virtual int RenderVolumetricGeometry(vtkViewport *)
Definition vtkProp.h:226
virtual vtkMatrix4x4 * GetMatrix()
Definition vtkProp.h:166
virtual double * GetBounds()
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Definition vtkProp.h:135
void AddConsumer(vtkObject *c)
Add or remove or get or check a consumer,.
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
Definition vtkProp.h:225
virtual void SetAllocatedRenderTime(double t, vtkViewport *vtkNotUsed(v))
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:381
virtual void SetPropertyKeys(vtkInformation *keys)
Set/Get property keys.
virtual bool RenderFilteredOpaqueGeometry(vtkViewport *v, vtkInformation *requiredKeys)
Render the opaque geometry only if the prop has all the requiredKeys.
virtual void GetActors(vtkPropCollection *)
For some exporters and other other operations we must be able to collect all the actors or volumes.
Definition vtkProp.h:67
vtkTypeBool Visibility
Definition vtkProp.h:465
virtual int RenderOverlay(vtkViewport *)
Definition vtkProp.h:227
virtual bool HasKeys(vtkInformation *requiredKeys)
Tells if the prop has all the required keys.
virtual void GetVolumes(vtkPropCollection *)
Definition vtkProp.h:69
double RenderTimeMultiplier
Definition vtkProp.h:473
vtkShaderProperty * ShaderProperty
Definition vtkProp.h:486
virtual vtkMTimeType GetRedrawMTime()
Return the mtime of anything that would cause the rendered image to appear differently.
Definition vtkProp.h:117
virtual double GetEstimatedRenderTime(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:323
double AllocatedRenderTime
Definition vtkProp.h:470
virtual void SetShaderProperty(vtkShaderProperty *property)
Set/Get the shader property.
virtual void ShallowCopy(vtkProp *prop)
Shallow copy of this vtkProp.
virtual void ReleaseGraphicsResources(vtkWindow *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
Definition vtkProp.h:309
virtual void RestoreEstimatedRenderTime()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:347
virtual void GetActors2D(vtkPropCollection *)
Definition vtkProp.h:68
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual bool IsRenderingTranslucentPolygonalGeometry()
Definition vtkProp.h:458
represent GPU shader properties
abstract specification for Viewports
Definition vtkViewport.h:56
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_SIZEHINT(...)