vtkSMParaViewPipelineControllerWithRendering.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
22 #ifndef vtkSMParaViewPipelineControllerWithRendering_h
23 #define vtkSMParaViewPipelineControllerWithRendering_h
24 
25 #include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_12_0
26 #include "vtkRemotingViewsModule.h" //needed for exports
28 
29 class vtkSMSourceProxy;
31 class vtkSMViewProxy;
32 
35 {
36 public:
39  void PrintSelf(ostream& os, vtkIndent indent) override;
40 
45  virtual vtkSMProxy* Show(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
46 
53  virtual vtkSMProxy* Show(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view,
54  const char* representationType);
55 
59  void ShowAll(vtkSMViewProxy* view);
60 
65  virtual vtkSMProxy* Hide(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
66 
70  virtual void Hide(vtkSMProxy* repr, vtkSMViewProxy* view);
71 
75  virtual void HideAll(vtkSMViewProxy* view);
76 
81  vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view, bool visible)
82  {
83  return (
84  visible ? this->Show(producer, outputPort, view) : this->Hide(producer, outputPort, view));
85  }
86 
90  virtual bool GetVisibility(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
91 
111  virtual vtkSMViewProxy* ShowInPreferredView(
112  vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
113 
141  virtual const char* GetPreferredViewType(vtkSMSourceProxy* producer, int outputPort);
142 
167  virtual const char* GetPipelineIcon(vtkSMSourceProxy* producer, int outputPort);
168 
169  using Superclass::RegisterRepresentationProxy;
176  bool RegisterRepresentationProxy(vtkSMProxy* proxy) override;
177 
181  static void SetHideScalarBarOnHide(bool);
182 
184 
190  static void SetInheritRepresentationProperties(bool);
191  static bool GetInheritRepresentationProperties();
193 
197  bool PostInitializeProxy(vtkSMProxy* proxy) override;
198 
203  virtual bool RegisterLayoutProxy(vtkSMProxy* proxy, const char* proxyname = nullptr);
204 
215  virtual void AssignViewToLayout(
216  vtkSMViewProxy* view, vtkSMViewLayoutProxy* layout = nullptr, int hint = 0);
217 
218 protected:
221 
222  virtual void UpdatePipelineBeforeDisplay(
223  vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
224 
229  virtual bool AlsoShowInCurrentView(
230  vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* currentView);
231 
236  "Material setup is now handled by the RenderView proxy on raytracing back-end update")
237  void DoMaterialSetup(vtkSMProxy* proxy) override;
238 
239 private:
242  void operator=(const vtkSMParaViewPipelineControllerWithRendering&) = delete;
243  static bool HideScalarBarOnHide;
244  static bool InheritRepresentationProperties;
245  bool SkipUpdatePipelineBeforeDisplay;
246 };
247 
248 #endif
vtkSMParaViewPipelineControllerWithRendering overrides vtkSMParaViewPipelineController to add support...
#define PARAVIEW_DEPRECATED_IN_5_12_0(reason)
virtual bool PostInitializeProxy(vtkSMProxy *proxy)
Final step in proxy initialization.
Controller that encapsulates control logic for typical ParaView applications.
#define VTKREMOTINGVIEWS_EXPORT
virtual bool RegisterRepresentationProxy(vtkSMProxy *proxy)
Registration method for representations to be used after PreInitializeProxy() and PostInitializeProxy...
Superclass for all view proxies.
vtkSMProxy * SetVisibility(vtkSMSourceProxy *producer, int outputPort, vtkSMViewProxy *view, bool visible)
Alternative method to call Show and Hide using a visibility flag.
void PrintSelf(ostream &os, vtkIndent indent) override
proxy for a VTK source on a server
vtkSMViewLayoutProxy is used by ParaView to layout multiple views in a 2D KD-Tree layout...
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:140
static vtkSMParaViewPipelineController * New()
virtual void DoMaterialSetup(vtkSMProxy *proxy)
An entry point to load a catalog of OSPRay rendering materials.