VTK  9.1.0
vtkCompositePolyDataMapper2.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCompositePolyDataMapper2.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 =========================================================================*/
60 #ifndef vtkCompositePolyDataMapper2_h
61 #define vtkCompositePolyDataMapper2_h
62 
64 #include "vtkRenderingOpenGL2Module.h" // For export macro
65 #include "vtkSmartPointer.h" // for vtkSmartPointer
66 
67 #include "vtkColor.h" // used for ivars
68 #include <map> // use for ivars
69 #include <stack> // used for ivars
70 #include <vector> // used for ivars
71 
75 
76 class VTKRENDERINGOPENGL2_EXPORT vtkCompositePolyDataMapper2 : public vtkOpenGLPolyDataMapper
77 {
78 public:
81  void PrintSelf(ostream& os, vtkIndent indent) override;
82 
84 
89  bool HasOpaqueGeometry() override;
92 
94 
100 
102 
105  void SetBlockVisibility(unsigned int index, bool visible);
106  bool GetBlockVisibility(unsigned int index);
107  void RemoveBlockVisibility(unsigned int index);
110 
112 
115  void SetBlockColor(unsigned int index, const double color[3]);
116  void SetBlockColor(unsigned int index, double r, double g, double b)
117  {
118  double color[3] = { r, g, b };
119  this->SetBlockColor(index, color);
120  }
121  double* GetBlockColor(unsigned int index);
122  void RemoveBlockColor(unsigned int index);
125 
127 
130  void SetBlockOpacity(unsigned int index, double opacity);
131  double GetBlockOpacity(unsigned int index);
132  void RemoveBlockOpacity(unsigned int index);
135 
142  vtkSetMacro(ColorMissingArraysWithNanColor, bool);
143  vtkGetMacro(ColorMissingArraysWithNanColor, bool);
144  vtkBooleanMacro(ColorMissingArraysWithNanColor, bool);
153 
157  void Render(vtkRenderer* ren, vtkActor* act) override;
158 
162  void SetVBOShiftScaleMethod(int m) override;
163 
168  void SetPauseShiftScale(bool pauseShiftScale) override;
169 
171 
176  int idx, int port, int connection, int fieldAssociation, const char* name) override;
178  int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) override;
179  void SetInputArrayToProcess(int idx, vtkInformation* info) override;
181 
185  std::vector<vtkPolyData*> GetRenderedList() { return this->RenderedList; }
186 
192  vtkHardwareSelector* sel, std::vector<unsigned int>& pixeloffsets, vtkProp* prop) override;
193 
197  vtkMTimeType GetMTime() override;
198 
199 protected:
202 
209 
214 
218  void ComputeBounds() override;
219 
225  vtkRenderer* vtkNotUsed(ren), vtkActor* vtkNotUsed(act))
226  {
227  }
228 
233 
234  // what "index" are we currently rendering, -1 means none
236  std::map<const std::string, vtkCompositeMapperHelper2*> Helpers;
237  std::map<vtkPolyData*, vtkCompositeMapperHelperData*> HelperDataMap;
239 
241 
242  // copy values to the helpers
244 
246  {
247  public:
248  std::stack<bool> Visibility;
249  std::stack<bool> Pickability;
250  std::stack<double> Opacity;
251  std::stack<vtkColor3d> AmbientColor;
252  std::stack<vtkColor3d> DiffuseColor;
253  std::stack<vtkColor3d> SpecularColor;
254  std::stack<vtkColor3d> SelectionColor;
255  std::stack<float> SelectionOpacity;
256  };
257 
258  bool RecursiveHasTranslucentGeometry(vtkDataObject* dobj, unsigned int& flat_index);
261 
263  vtkRenderer* renderer, vtkActor* actor, vtkDataObject* dobj, unsigned int& flat_index);
265 
268  vtkRenderer* renderer, vtkActor* actor, vtkDataObject* dobj, unsigned int& flat_index);
269 
274 
276 
282 
283  std::vector<vtkPolyData*> RenderedList;
284 
285 private:
286  double ColorResult[3];
287 
289  void operator=(const vtkCompositePolyDataMapper2&) = delete;
290 };
291 
292 #endif
vtkCompositePolyDataMapper2::RemoveBlockOpacities
void RemoveBlockOpacities()
Set/get the opacity for a block given its flat index.
vtkCompositePolyDataMapper2::GetBlockColor
double * GetBlockColor(unsigned int index)
Set/get the color for a block given its flat index.
vtkCompositePolyDataMapper2::SetInputArrayToProcess
void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) override
Call SetInputArrayToProcess on helpers.
vtkCompositePolyDataMapper2::HasTranslucentGeometry
bool HasTranslucentGeometry
Definition: vtkCompositePolyDataMapper2.h:260
vtkCompositePolyDataMapper2::SetBlockVisibility
void SetBlockVisibility(unsigned int index, bool visible)
Set/get the visibility for a block given its flat index.
vtkCompositePolyDataMapper2::RenderedList
std::vector< vtkPolyData * > RenderedList
Definition: vtkCompositePolyDataMapper2.h:283
vtkCompositePolyDataMapper2::ColorMissingArraysWithNanColor
bool ColorMissingArraysWithNanColor
If the current 'color by' array is missing on some datasets, color these dataset by the LookupTable's...
Definition: vtkCompositePolyDataMapper2.h:281
vtkStateStorage
Class to make storing and comparing state quick and easy.
Definition: vtkStateStorage.h:130
vtkCompositePolyDataMapper2::SetInputArrayToProcess
void SetInputArrayToProcess(int idx, vtkInformation *info) override
Call SetInputArrayToProcess on helpers.
vtkCompositePolyDataMapper2::CurrentFlatIndex
int CurrentFlatIndex
Definition: vtkCompositePolyDataMapper2.h:235
vtkCompositePolyDataMapper2::RenderBlockState::Opacity
std::stack< double > Opacity
Definition: vtkCompositePolyDataMapper2.h:250
vtkCompositePolyDataMapper2::RenderBlockState::Visibility
std::stack< bool > Visibility
Definition: vtkCompositePolyDataMapper2.h:248
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:52
vtkCompositePolyDataMapper2::SetPauseShiftScale
void SetPauseShiftScale(bool pauseShiftScale) override
Pause updates of shift-scale parameters based on camera position.
vtkCompositePolyDataMapper2::~vtkCompositePolyDataMapper2
~vtkCompositePolyDataMapper2() override
vtkCompositePolyDataMapper2::CompositeAttributes
vtkSmartPointer< vtkCompositeDataDisplayAttributes > CompositeAttributes
Composite data set attributes.
Definition: vtkCompositePolyDataMapper2.h:273
vtkSmartPointer< vtkCompositeDataDisplayAttributes >
vtkCompositePolyDataMapper2::BoundsMTime
vtkTimeStamp BoundsMTime
Time stamp for computation of bounds.
Definition: vtkCompositePolyDataMapper2.h:232
vtkCompositePolyDataMapper2::RenderBlockState::SelectionColor
std::stack< vtkColor3d > SelectionColor
Definition: vtkCompositePolyDataMapper2.h:254
vtkCompositePolyDataMapper2::CopyMapperValuesToHelper
virtual void CopyMapperValuesToHelper(vtkCompositeMapperHelper2 *helper)
vtkCompositePolyDataMapper2::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Need to define the type of data handled by this mapper.
vtkCompositePolyDataMapper2
mapper for composite dataset consisting of polygonal data.
Definition: vtkCompositePolyDataMapper2.h:77
vtkCompositePolyDataMapper2::SetInputArrayToProcess
void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, const char *name) override
Call SetInputArrayToProcess on helpers.
vtkCompositePolyDataMapper2::RemoveBlockColor
void RemoveBlockColor(unsigned int index)
Set/get the color for a block given its flat index.
vtkCompositePolyDataMapper2::SetBlockColor
void SetBlockColor(unsigned int index, const double color[3])
Set/get the color for a block given its flat index.
vtkCompositeMapperHelperData
Definition: vtkCompositeMapperHelper2.h:29
vtkCompositePolyDataMapper2::RecursiveHasTranslucentGeometry
bool RecursiveHasTranslucentGeometry(vtkDataObject *dobj, unsigned int &flat_index)
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
vtkCompositeDataDisplayAttributes
Rendering attributes for a multi-block dataset.
Definition: vtkCompositeDataDisplayAttributes.h:59
vtkCompositePolyDataMapper2::Helpers
std::map< const std::string, vtkCompositeMapperHelper2 * > Helpers
Definition: vtkCompositePolyDataMapper2.h:236
vtkCompositePolyDataMapper2::RenderBlockState::AmbientColor
std::stack< vtkColor3d > AmbientColor
Definition: vtkCompositePolyDataMapper2.h:251
vtkCompositePolyDataMapper2::SetBlockOpacity
void SetBlockOpacity(unsigned int index, double opacity)
Set/get the opacity for a block given its flat index.
vtkCompositePolyDataMapper2::GetCompositeDataDisplayAttributes
vtkCompositeDataDisplayAttributes * GetCompositeDataDisplayAttributes()
Set/get the composite data set attributes.
vtkCompositePolyDataMapper2::RenderBlockState::Pickability
std::stack< bool > Pickability
Definition: vtkCompositePolyDataMapper2.h:249
vtkX3D::color
@ color
Definition: vtkX3D.h:227
vtkX3D::port
@ port
Definition: vtkX3D.h:453
vtkExecutive
Superclass for all pipeline executives in VTK.
Definition: vtkExecutive.h:76
vtkCompositePolyDataMapper2::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this mapper.
vtkCompositePolyDataMapper2::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCompositePolyDataMapper2::RenderBlockState::SelectionOpacity
std::stack< float > SelectionOpacity
Definition: vtkCompositePolyDataMapper2.h:255
vtkCompositePolyDataMapper2::CreateHelper
virtual vtkCompositeMapperHelper2 * CreateHelper()
vtkCompositeMapperHelper2
Helper class for vtkCompositePolyDataMapper2 that is a subclass of vtkOpenGLPolyDataMapper.
Definition: vtkCompositeMapperHelper2.h:59
vtkCompositePolyDataMapper2::HelperMTime
vtkTimeStamp HelperMTime
Definition: vtkCompositePolyDataMapper2.h:238
vtkCompositePolyDataMapper2::RenderBlockState
Definition: vtkCompositePolyDataMapper2.h:246
vtkHardwareSelector
Definition: vtkHardwareSelector.h:153
vtkColor.h
vtkCompositePolyDataMapper2::GetBlockOpacity
double GetBlockOpacity(unsigned int index)
Set/get the opacity for a block given its flat index.
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:155
vtkCompositePolyDataMapper2::SetVBOShiftScaleMethod
void SetVBOShiftScaleMethod(int m) override
A convenience method for enabling/disabling the VBO's shift+scale transform.
vtkCompositePolyDataMapper2::HelperDataMap
std::map< vtkPolyData *, vtkCompositeMapperHelperData * > HelperDataMap
Definition: vtkCompositePolyDataMapper2.h:237
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:113
vtkCompositePolyDataMapper2::CreateDefaultExecutive
vtkExecutive * CreateDefaultExecutive() override
We need to override this method because the standard streaming demand driven pipeline is not what we ...
vtkSmartPointer.h
vtkCompositePolyDataMapper2::SetBlockColor
void SetBlockColor(unsigned int index, double r, double g, double b)
Set/get the color for a block given its flat index.
Definition: vtkCompositePolyDataMapper2.h:116
vtkCompositePolyDataMapper2::RemoveBlockColors
void RemoveBlockColors()
Set/get the color for a block given its flat index.
vtkCompositePolyDataMapper2::TranslucentState
vtkStateStorage TranslucentState
Definition: vtkCompositePolyDataMapper2.h:259
vtkCompositePolyDataMapper2::RemoveBlockOpacity
void RemoveBlockOpacity(unsigned int index)
Set/get the opacity for a block given its flat index.
vtkCompositePolyDataMapper2::HasTranslucentPolygonalGeometry
bool HasTranslucentPolygonalGeometry() override
Some introspection on the type of data the mapper will render used by props to determine if they shou...
vtkX3D::name
@ name
Definition: vtkX3D.h:225
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:183
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:76
vtkCompositePolyDataMapper2::InitializeHelpersBeforeRendering
virtual void InitializeHelpersBeforeRendering(vtkRenderer *vtkNotUsed(ren), vtkActor *vtkNotUsed(act))
This method is called before RenderPiece is called on helpers.
Definition: vtkCompositePolyDataMapper2.h:224
vtkX3D::info
@ info
Definition: vtkX3D.h:382
vtkCompositePolyDataMapper2::ProcessSelectorPixelBuffers
void ProcessSelectorPixelBuffers(vtkHardwareSelector *sel, std::vector< unsigned int > &pixeloffsets, vtkProp *prop) override
allows a mapper to update a selections color buffers Called from a prop which in turn is called from ...
vtkCompositePolyDataMapper2::RenderBlockState::SpecularColor
std::stack< vtkColor3d > SpecularColor
Definition: vtkCompositePolyDataMapper2.h:253
vtkCompositePolyDataMapper2::New
static vtkCompositePolyDataMapper2 * New()
vtkCompositePolyDataMapper2::GetBlockVisibility
bool GetBlockVisibility(unsigned int index)
Set/get the visibility for a block given its flat index.
vtkCompositePolyDataMapper2::RenderBlockState::DiffuseColor
std::stack< vtkColor3d > DiffuseColor
Definition: vtkCompositePolyDataMapper2.h:252
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:182
vtkCompositePolyDataMapper2::RemoveBlockVisibilities
void RemoveBlockVisibilities()
Set/get the visibility for a block given its flat index.
vtkCompositePolyDataMapper2::ComputeBounds
void ComputeBounds() override
Need to loop over the hierarchy to compute bounds.
vtkCompositePolyDataMapper2::RenderBlock
void RenderBlock(vtkRenderer *renderer, vtkActor *actor, vtkDataObject *dobj, unsigned int &flat_index)
vtkCompositePolyDataMapper2::HasOpaqueGeometry
bool HasOpaqueGeometry() override
Some introspection on the type of data the mapper will render used by props to determine if they shou...
vtkCompositePolyDataMapper2::RenderValuesState
vtkStateStorage RenderValuesState
Definition: vtkCompositePolyDataMapper2.h:264
vtkCompositePolyDataMapper2::RemoveBlockVisibility
void RemoveBlockVisibility(unsigned int index)
Set/get the visibility for a block given its flat index.
vtkCompositePolyDataMapper2::GetMTime
vtkMTimeType GetMTime() override
Overridden to include vtkCompositeDataDisplayAttributes' mtime.
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:169
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkOpenGLPolyDataMapper.h
vtkCompositePolyDataMapper2::SetCompositeDataDisplayAttributes
void SetCompositeDataDisplayAttributes(vtkCompositeDataDisplayAttributes *attributes)
Set/get the composite data set attributes.
vtkOpenGLPolyDataMapper
PolyDataMapper using OpenGL to render.
Definition: vtkOpenGLPolyDataMapper.h:149
vtkAlgorithm::SetInputArrayToProcess
virtual void SetInputArrayToProcess(int idx, int port, int connection, int fieldAssociation, const char *name)
Set the input data arrays that this algorithm will process.
vtkCompositePolyDataMapper2::BuildRenderValues
void BuildRenderValues(vtkRenderer *renderer, vtkActor *actor, vtkDataObject *dobj, unsigned int &flat_index)
vtkCompositePolyDataMapper2::vtkCompositePolyDataMapper2
vtkCompositePolyDataMapper2()
vtkCompositePolyDataMapper2::BlockState
RenderBlockState BlockState
Definition: vtkCompositePolyDataMapper2.h:266
vtkCompositePolyDataMapper2::Render
void Render(vtkRenderer *ren, vtkActor *act) override
This calls RenderPiece (in a for loop if streaming is necessary).
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287
vtkCompositePolyDataMapper2::GetRenderedList
std::vector< vtkPolyData * > GetRenderedList()
Accessor to the ordered list of PolyData that we end last drew.
Definition: vtkCompositePolyDataMapper2.h:185