1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*=========================================================================
Program: ParaView
Module: vtkSMParaViewPipelineControllerWithRendering.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkSMParaViewPipelineControllerWithRendering
*
* vtkSMParaViewPipelineControllerWithRendering overrides
* vtkSMParaViewPipelineController to add support for initializing rendering
* proxies appropriately. vtkSMParaViewPipelineControllerWithRendering uses
* vtkObjectFactory mechanisms to override vtkSMParaViewPipelineController's
* creation. One should not need to create or use this class directly (excepting
* when needing to subclass). Simply create vtkSMParaViewPipelineController. If
* the application is linked with the rendering module, then this class will be
* instantiated instead of vtkSMParaViewPipelineController automatically.
*
* vtkSMParaViewPipelineControllerWithRendering also adds new API to control
* representation visibility and manage creation of views. To use that API
* clients can instantiate vtkSMParaViewPipelineControllerWithRendering. Just
* like vtkSMParaViewPipelineController, this class also uses vtkObjectFactory
* mechanisms to enable overriding by clients at compile time.
*/
#ifndef vtkSMParaViewPipelineControllerWithRendering_h
#define vtkSMParaViewPipelineControllerWithRendering_h
#include "vtkPVServerManagerRenderingModule.h" //needed for exports
#include "vtkSMParaViewPipelineController.h"
class vtkSMSourceProxy;
class vtkSMViewLayoutProxy;
class vtkSMViewProxy;
class VTKPVSERVERMANAGERRENDERING_EXPORT vtkSMParaViewPipelineControllerWithRendering
: public vtkSMParaViewPipelineController
{
public:
static vtkSMParaViewPipelineControllerWithRendering* New();
vtkTypeMacro(vtkSMParaViewPipelineControllerWithRendering, vtkSMParaViewPipelineController);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Show the output data in the view. If data cannot be shown in the view,
* returns NULL. If \c view is NULL, this simply calls ShowInPreferredView().
*/
virtual vtkSMProxy* Show(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
/**
* Opposite of Show(). Locates the representation for the producer and then
* hides it, if found. Returns that representation, if found.
*/
virtual vtkSMProxy* Hide(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
/**
* Same as above, except that when we already have the representation located.
*/
virtual void Hide(vtkSMProxy* repr, vtkSMViewProxy* view);
/**
* Hide all visible sources output ports in provided view
*/
virtual void HideAll(vtkSMViewProxy* view);
/**
* Alternative method to call Show and Hide using a visibility flag.
*/
vtkSMProxy* SetVisibility(
vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view, bool visible)
{
return (
visible ? this->Show(producer, outputPort, view) : this->Hide(producer, outputPort, view));
}
/**
* Returns whether the producer/port are shown in the given view.
*/
virtual bool GetVisibility(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
/**
* Same as Show() except that if the \c view is NULL or not the preferred
* view for the producer's output, this method will create a new view and show
* the data in that new view.
*
* There are several different strategies employed to determine the preferred
* view for the producer's output. See
* vtkSMParaViewPipelineControllerWithRendering::GetPreferredViewType() for
* details.
*
* @note if the source's hint indicates so, the data may also be
* shown in the \c view passed in, in addition to the preferred view.
* This is done by using the `also_show_in_current_view` attribute to
* the `<View />` hint.
*
* @returns the view in which the data ends up being shown, if any.
* It may return nullptr if the \c view is not the preferred type
* or the preferred cannot be determined or created.
*/
virtual vtkSMViewProxy* ShowInPreferredView(
vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
/**
* Returns the name for the preferred view type, if there is any. There are
* several strategies employed by the default implementation to determine the
* preferred view type.
*
* -# Using XML hints.\n
* A producer proxy can provide XML hints to define the preferred view type
* of each (or all) of its output ports. This is done as follows:
*
* @code{xml}
* <SourceProxy>
* <Hints>
* <View type="<view name>" port="<output port number" />
* </Hints>
* </SourceProxy>
* @endcode
*
* Attribute `port` is optional and only needed to explicitly specify
* different view types for different output ports.
*
* -# Using data type.\n
* If the data type for the generated data is `vtkTable`, then the
* preferred view (if none provided) is assumed to be `SpreadSheetView`.
*
* @returns XML name for the preferred view proxy. It is assumed to be defined
* in the "views" group.
*/
virtual const char* GetPreferredViewType(vtkSMSourceProxy* producer, int outputPort);
/**
* Overridden to create color and opacity transfer functions if applicable.
* While it is tempting to add any default property setup logic in such
* overrides, we must keep such overrides to a minimal and opting for domains
* that set appropriate defaults where as much as possible.
*/
virtual bool RegisterRepresentationProxy(vtkSMProxy* proxy) VTK_OVERRIDE;
/**
* Control how scalar bar visibility is updated by the Hide call.
*/
static void SetHideScalarBarOnHide(bool);
//@{
/**
* Control whether representations try to maintain properties from an input
* representation, if present. e.g. if you "Transform" the representation for
* a source, then any filter that you connect to it should be transformed as
* well.
*/
static void SetInheritRepresentationProperties(bool);
static bool GetInheritRepresentationProperties();
//@}
//@{
/*
* @deprecated since ParaView 5.4. Use vtkSMSaveScreenshotProxy instead.
*/
VTK_LEGACY(virtual bool WriteImage(
vtkSMViewProxy* view, const char* filename, int magnification, int quality) VTK_FINAL);
VTK_LEGACY(virtual bool WriteImage(
vtkSMViewLayoutProxy* layout, const char* filename, int magnification, int quality) VTK_FINAL);
//@}
/**
* Overridden to handle default ColorArrayName for representations correctly.
*/
virtual bool PostInitializeProxy(vtkSMProxy* proxy) VTK_OVERRIDE;
//@{
/**
* Overridden to place the view in a layout on creation.
*/
virtual bool RegisterViewProxy(vtkSMProxy* proxy, const char* proxyname) VTK_OVERRIDE;
using Superclass::RegisterViewProxy;
//@}
/**
* Register layout proxy.
*/
virtual bool RegisterLayoutProxy(vtkSMProxy* proxy, const char* proxyname = NULL);
protected:
vtkSMParaViewPipelineControllerWithRendering();
~vtkSMParaViewPipelineControllerWithRendering();
virtual void UpdatePipelineBeforeDisplay(
vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
/**
* Checks if the output from producer needs to be shown in the current view
* also.
*/
virtual bool AlsoShowInCurrentView(
vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* currentView);
private:
vtkSMParaViewPipelineControllerWithRendering(
const vtkSMParaViewPipelineControllerWithRendering&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMParaViewPipelineControllerWithRendering&) VTK_DELETE_FUNCTION;
static bool HideScalarBarOnHide;
static bool InheritRepresentationProperties;
};
#endif
|
