VTK  9.5.20250718
vtkProp.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
44#ifndef vtkProp_h
45#define vtkProp_h
46
47#include "vtkObject.h"
48#include "vtkRenderingCoreModule.h" // For export macro
49#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
50#include <vector> // for method args
51
52VTK_ABI_NAMESPACE_BEGIN
53class vtkAssemblyPath;
56class vtkMatrix4x4;
58class vtkViewport;
59class vtkWindow;
60class vtkInformation;
64
65class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkProp : public vtkObject
66{
67public:
68 vtkTypeMacro(vtkProp, vtkObject);
69 void PrintSelf(ostream& os, vtkIndent indent) override;
70
76 virtual void GetActors(vtkPropCollection*) {}
78 virtual void GetVolumes(vtkPropCollection*) {}
79
81
84 vtkSetMacro(Visibility, vtkTypeBool);
85 vtkGetMacro(Visibility, vtkTypeBool);
86 vtkBooleanMacro(Visibility, vtkTypeBool);
88
90
95 vtkSetMacro(Pickable, vtkTypeBool);
96 vtkGetMacro(Pickable, vtkTypeBool);
97 vtkBooleanMacro(Pickable, vtkTypeBool);
99
103 virtual void Pick();
104
106
115 vtkSetMacro(Dragable, vtkTypeBool);
116 vtkGetMacro(Dragable, vtkTypeBool);
117 vtkBooleanMacro(Dragable, vtkTypeBool);
119
126 virtual vtkMTimeType GetRedrawMTime() { return this->GetMTime(); }
127
129
135 vtkSetMacro(UseBounds, bool);
136 vtkGetMacro(UseBounds, bool);
137 vtkBooleanMacro(UseBounds, bool);
139
144 virtual double* GetBounds() VTK_SIZEHINT(6) { return nullptr; }
145
149 virtual void ShallowCopy(vtkProp* prop);
150
152
164 virtual void InitPathTraversal();
166 virtual int GetNumberOfPaths() { return 1; }
168
174 virtual void PokeMatrix(vtkMatrix4x4* vtkNotUsed(matrix)) {}
175 virtual vtkMatrix4x4* GetMatrix() { return nullptr; }
176
178
190 vtkGetObjectMacro(PropertyKeys, vtkInformation);
191 virtual void SetPropertyKeys(vtkInformation* keys);
193
198 virtual bool HasKeys(vtkInformation* requiredKeys);
199
210
221
238 virtual int RenderOpaqueGeometry(vtkViewport*) { return 0; }
240 virtual int RenderVolumetricGeometry(vtkViewport*) { return 0; }
241 virtual int RenderOverlay(vtkViewport*) { return 0; }
242
253
265 vtkViewport* v, vtkInformation* requiredKeys);
266
278
289 virtual bool RenderFilteredOverlay(vtkViewport* v, vtkInformation* requiredKeys);
290
303
315 virtual vtkTypeBool HasOpaqueGeometry() { return 1; }
316
324
337 virtual double GetEstimatedRenderTime(vtkViewport*) { return this->EstimatedRenderTime; }
338 virtual double GetEstimatedRenderTime() { return this->EstimatedRenderTime; }
339
347 virtual void SetEstimatedRenderTime(double t)
348 {
349 this->EstimatedRenderTime = t;
350 this->SavedEstimatedRenderTime = t;
351 }
352
362 {
363 this->EstimatedRenderTime = this->SavedEstimatedRenderTime;
364 }
365
379 virtual void AddEstimatedRenderTime(double t, vtkViewport* vtkNotUsed(vp))
380 {
381 this->EstimatedRenderTime += t;
382 }
383
385
395 virtual void SetAllocatedRenderTime(double t, vtkViewport* vtkNotUsed(v))
396 {
397 this->AllocatedRenderTime = t;
398 this->SavedEstimatedRenderTime = this->EstimatedRenderTime;
399 this->EstimatedRenderTime = 0.0;
400 }
402
404
408 vtkGetMacro(AllocatedRenderTime, double);
410
418 void SetRenderTimeMultiplier(double t) { this->RenderTimeMultiplier = t; }
419 vtkGetMacro(RenderTimeMultiplier, double);
420
426 virtual void BuildPaths(vtkAssemblyPaths* paths, vtkAssemblyPath* path);
427
434 virtual bool GetSupportsSelection() { return false; }
435
441 vtkHardwareSelector* /* sel */, std::vector<unsigned int>& /* pixeloffsets */)
442 {
443 }
444
446
449 vtkGetMacro(NumberOfConsumers, int);
451
453
461
463
466 virtual void SetShaderProperty(vtkShaderProperty* property);
469
471 // Get if we are in the translucent polygonal geometry pass
472 virtual bool IsRenderingTranslucentPolygonalGeometry() { return false; }
474
475protected:
477 ~vtkProp() override;
478
483
488
489 // how many consumers does this object have
492
493 // support multi-part props and access to paths of prop
494 // stuff that follows is used to build the assembly hierarchy
496
498
499 // User-defined shader replacement and uniform variables
501
502private:
503 vtkProp(const vtkProp&) = delete;
504 void operator=(const vtkProp&) = delete;
505};
506
507VTK_ABI_NAMESPACE_END
508#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:108
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:162
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:66
virtual void ProcessSelectorPixelBuffers(vtkHardwareSelector *, std::vector< unsigned int > &)
allows a prop to update a selections color buffers
Definition vtkProp.h:440
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:315
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 void AddEstimatedRenderTime(double t, vtkViewport *vp)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:379
virtual double GetEstimatedRenderTime()
Definition vtkProp.h:338
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:491
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:495
void SetRenderTimeMultiplier(double t)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:418
virtual int GetNumberOfPaths()
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g.,...
Definition vtkProp.h:166
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:347
virtual int RenderOpaqueGeometry(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:238
virtual void Pick()
Method fires PickEvent if the prop is picked.
vtkInformation * PropertyKeys
Definition vtkProp.h:497
bool UseBounds
Definition vtkProp.h:482
vtkTypeBool Pickable
Definition vtkProp.h:480
virtual bool GetSupportsSelection()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:434
virtual vtkAssemblyPath * GetNextPath()
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g.,...
int NumberOfConsumers
Definition vtkProp.h:490
void RemoveConsumer(vtkObject *c)
Add or remove or get or check a consumer,.
double SavedEstimatedRenderTime
Definition vtkProp.h:486
virtual vtkTypeBool HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:302
vtkTypeBool Dragable
Definition vtkProp.h:481
virtual void InitPathTraversal()
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g.,...
virtual void PokeMatrix(vtkMatrix4x4 *matrix)
These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
Definition vtkProp.h:174
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...
virtual void SetAllocatedRenderTime(double t, vtkViewport *v)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
Definition vtkProp.h:395
double EstimatedRenderTime
Definition vtkProp.h:485
virtual int RenderVolumetricGeometry(vtkViewport *)
Definition vtkProp.h:240
virtual vtkMatrix4x4 * GetMatrix()
Definition vtkProp.h:175
virtual double * GetBounds()
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
Definition vtkProp.h:144
void AddConsumer(vtkObject *c)
Add or remove or get or check a consumer,.
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
Definition vtkProp.h:239
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:76
vtkTypeBool Visibility
Definition vtkProp.h:479
virtual int RenderOverlay(vtkViewport *)
Definition vtkProp.h:241
virtual bool HasKeys(vtkInformation *requiredKeys)
Tells if the prop has all the required keys.
virtual void GetVolumes(vtkPropCollection *)
Definition vtkProp.h:78
double RenderTimeMultiplier
Definition vtkProp.h:487
vtkShaderProperty * ShaderProperty
Definition vtkProp.h:500
virtual vtkMTimeType GetRedrawMTime()
Return the mtime of anything that would cause the rendered image to appear differently.
Definition vtkProp.h:126
virtual double GetEstimatedRenderTime(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:337
double AllocatedRenderTime
Definition vtkProp.h:484
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:323
virtual void RestoreEstimatedRenderTime()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
Definition vtkProp.h:361
virtual void GetActors2D(vtkPropCollection *)
Definition vtkProp.h:77
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:472
represent GPU shader properties
abstract specification for Viewports
Definition vtkViewport.h:66
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
int vtkTypeBool
Definition vtkABI.h:64
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287
#define VTK_SIZEHINT(...)
#define VTK_MARSHALAUTO