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=========================================================================*/
31#ifndef vtkProp_h
32#define vtkProp_h
33
34#include "vtkObject.h"
35#include "vtkRenderingCoreModule.h" // For export macro
36#include <vector> // for method args
37
38class vtkAssemblyPath;
41class vtkMatrix4x4;
43class vtkViewport;
44class vtkWindow;
45class vtkInformation;
49
50class VTKRENDERINGCORE_EXPORT vtkProp : public vtkObject
51{
52public:
53 vtkTypeMacro(vtkProp, vtkObject);
54 void PrintSelf(ostream& os, vtkIndent indent) override;
55
61 virtual void GetActors(vtkPropCollection*) {}
63 virtual void GetVolumes(vtkPropCollection*) {}
64
66
69 vtkSetMacro(Visibility, vtkTypeBool);
70 vtkGetMacro(Visibility, vtkTypeBool);
71 vtkBooleanMacro(Visibility, vtkTypeBool);
73
75
80 vtkSetMacro(Pickable, vtkTypeBool);
81 vtkGetMacro(Pickable, vtkTypeBool);
82 vtkBooleanMacro(Pickable, vtkTypeBool);
84
88 virtual void Pick();
89
91
100 vtkSetMacro(Dragable, vtkTypeBool);
101 vtkGetMacro(Dragable, vtkTypeBool);
102 vtkBooleanMacro(Dragable, vtkTypeBool);
104
111 virtual vtkMTimeType GetRedrawMTime() { return this->GetMTime(); }
112
114
120 vtkSetMacro(UseBounds, bool);
121 vtkGetMacro(UseBounds, bool);
122 vtkBooleanMacro(UseBounds, bool);
124
129 virtual double* GetBounds() VTK_SIZEHINT(6) { return nullptr; }
130
134 virtual void ShallowCopy(vtkProp* prop);
135
137
149 virtual void InitPathTraversal();
151 virtual int GetNumberOfPaths() { return 1; }
153
159 virtual void PokeMatrix(vtkMatrix4x4* vtkNotUsed(matrix)) {}
160 virtual vtkMatrix4x4* GetMatrix() { return nullptr; }
161
163
170 vtkGetObjectMacro(PropertyKeys, vtkInformation);
171 virtual void SetPropertyKeys(vtkInformation* keys);
173
178 virtual bool HasKeys(vtkInformation* requiredKeys);
179
190
201
218 virtual int RenderOpaqueGeometry(vtkViewport*) { return 0; }
220 virtual int RenderVolumetricGeometry(vtkViewport*) { return 0; }
221 virtual int RenderOverlay(vtkViewport*) { return 0; }
222
233
245 vtkViewport* v, vtkInformation* requiredKeys);
246
258
269 virtual bool RenderFilteredOverlay(vtkViewport* v, vtkInformation* requiredKeys);
270
283
295 virtual vtkTypeBool HasOpaqueGeometry() { return 1; }
296
304
317 virtual double GetEstimatedRenderTime(vtkViewport*) { return this->EstimatedRenderTime; }
318 virtual double GetEstimatedRenderTime() { return this->EstimatedRenderTime; }
319
327 virtual void SetEstimatedRenderTime(double t)
328 {
329 this->EstimatedRenderTime = t;
330 this->SavedEstimatedRenderTime = t;
331 }
332
342 {
343 this->EstimatedRenderTime = this->SavedEstimatedRenderTime;
344 }
345
359 virtual void AddEstimatedRenderTime(double t, vtkViewport* vtkNotUsed(vp))
360 {
361 this->EstimatedRenderTime += t;
362 }
363
365
375 virtual void SetAllocatedRenderTime(double t, vtkViewport* vtkNotUsed(v))
376 {
377 this->AllocatedRenderTime = t;
378 this->SavedEstimatedRenderTime = this->EstimatedRenderTime;
379 this->EstimatedRenderTime = 0.0;
380 }
382
384
388 vtkGetMacro(AllocatedRenderTime, double);
390
398 void SetRenderTimeMultiplier(double t) { this->RenderTimeMultiplier = t; }
399 vtkGetMacro(RenderTimeMultiplier, double);
400
406 virtual void BuildPaths(vtkAssemblyPaths* paths, vtkAssemblyPath* path);
407
414 virtual bool GetSupportsSelection() { return false; }
415
421 vtkHardwareSelector* /* sel */, std::vector<unsigned int>& /* pixeloffsets */)
422 {
423 }
424
426
429 vtkGetMacro(NumberOfConsumers, int);
431
433
441
443
446 virtual void SetShaderProperty(vtkShaderProperty* property);
449
451 // Get if we are in the translucent polygonal geometry pass
452 virtual bool IsRenderingTranslucentPolygonalGeometry() { return false; }
454
455protected:
457 ~vtkProp() override;
458
463
468
469 // how many consumers does this object have
472
473 // support multi-part props and access to paths of prop
474 // stuff that follows is used to build the assembly hierarchy
476
478
479 // User-defined shader replacement and uniform variables
481
482private:
483 vtkProp(const vtkProp&) = delete;
484 void operator=(const vtkProp&) = delete;
485};
486
487#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:34
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:57
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:51
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:159
virtual void ProcessSelectorPixelBuffers(vtkHardwareSelector *, std::vector< unsigned int > &)
allows a prop to update a selections color buffers
Definition vtkProp.h:420
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:295
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:318
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:471
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:475
void SetRenderTimeMultiplier(double t)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:398
virtual int GetNumberOfPaths()
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g.,...
Definition vtkProp.h:151
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:327
virtual int RenderOpaqueGeometry(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:218
virtual void Pick()
Method fires PickEvent if the prop is picked.
vtkInformation * PropertyKeys
Definition vtkProp.h:477
bool UseBounds
Definition vtkProp.h:462
vtkTypeBool Pickable
Definition vtkProp.h:460
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:359
virtual bool GetSupportsSelection()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:414
virtual vtkAssemblyPath * GetNextPath()
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g.,...
int NumberOfConsumers
Definition vtkProp.h:470
void RemoveConsumer(vtkObject *c)
Add or remove or get or check a consumer,.
double SavedEstimatedRenderTime
Definition vtkProp.h:466
virtual vtkTypeBool HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:282
vtkTypeBool Dragable
Definition vtkProp.h:461
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:465
virtual int RenderVolumetricGeometry(vtkViewport *)
Definition vtkProp.h:220
virtual vtkMatrix4x4 * GetMatrix()
Definition vtkProp.h:160
virtual double * GetBounds()
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Definition vtkProp.h:129
void AddConsumer(vtkObject *c)
Add or remove or get or check a consumer,.
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
Definition vtkProp.h:219
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:375
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:61
vtkTypeBool Visibility
Definition vtkProp.h:459
virtual int RenderOverlay(vtkViewport *)
Definition vtkProp.h:221
virtual bool HasKeys(vtkInformation *requiredKeys)
Tells if the prop has all the required keys.
virtual void GetVolumes(vtkPropCollection *)
Definition vtkProp.h:63
double RenderTimeMultiplier
Definition vtkProp.h:467
vtkShaderProperty * ShaderProperty
Definition vtkProp.h:480
virtual vtkMTimeType GetRedrawMTime()
Return the mtime of anything that would cause the rendered image to appear differently.
Definition vtkProp.h:111
virtual double GetEstimatedRenderTime(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:317
double AllocatedRenderTime
Definition vtkProp.h:464
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:303
virtual void RestoreEstimatedRenderTime()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:341
virtual void GetActors2D(vtkPropCollection *)
Definition vtkProp.h:62
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:452
represent GPU shader properties
abstract specification for Viewports
Definition vtkViewport.h:50
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_SIZEHINT(...)