vtkSMParaViewPipelineControllerWithRendering.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: ParaView
4  Module: vtkSMParaViewPipelineControllerWithRendering.h
5 
6  Copyright (c) Kitware, Inc.
7  All rights reserved.
8  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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 =========================================================================*/
34 #ifndef vtkSMParaViewPipelineControllerWithRendering_h
35 #define vtkSMParaViewPipelineControllerWithRendering_h
36 
37 #include "vtkRemotingViewsModule.h" //needed for exports
39 
40 class vtkSMSourceProxy;
42 class vtkSMViewProxy;
43 
44 class VTKREMOTINGVIEWS_EXPORT vtkSMParaViewPipelineControllerWithRendering
46 {
47 public:
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
56  virtual vtkSMProxy* Show(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
57 
64  virtual vtkSMProxy* Show(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view,
65  const char* representationType);
66 
70  void ShowAll(vtkSMViewProxy* view);
71 
76  virtual vtkSMProxy* Hide(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
77 
81  virtual void Hide(vtkSMProxy* repr, vtkSMViewProxy* view);
82 
86  virtual void HideAll(vtkSMViewProxy* view);
87 
92  vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view, bool visible)
93  {
94  return (
95  visible ? this->Show(producer, outputPort, view) : this->Hide(producer, outputPort, view));
96  }
97 
101  virtual bool GetVisibility(vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
102 
122  virtual vtkSMViewProxy* ShowInPreferredView(
123  vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
124 
152  virtual const char* GetPreferredViewType(vtkSMSourceProxy* producer, int outputPort);
153 
178  virtual const char* GetPipelineIcon(vtkSMSourceProxy* producer, int outputPort);
179 
186  bool RegisterRepresentationProxy(vtkSMProxy* proxy) override;
187 
191  static void SetHideScalarBarOnHide(bool);
192 
194 
200  static void SetInheritRepresentationProperties(bool);
201  static bool GetInheritRepresentationProperties();
203 
207  bool PostInitializeProxy(vtkSMProxy* proxy) override;
208 
213  virtual bool RegisterLayoutProxy(vtkSMProxy* proxy, const char* proxyname = NULL);
214 
225  virtual void AssignViewToLayout(
226  vtkSMViewProxy* view, vtkSMViewLayoutProxy* layout = nullptr, int hint = 0);
227 
228 protected:
231 
232  virtual void UpdatePipelineBeforeDisplay(
233  vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* view);
234 
239  virtual bool AlsoShowInCurrentView(
240  vtkSMSourceProxy* producer, int outputPort, vtkSMViewProxy* currentView);
241 
245  virtual void DoMaterialSetup(vtkSMProxy* proxy) override;
246 
247 private:
250  void operator=(const vtkSMParaViewPipelineControllerWithRendering&) = delete;
251  static bool HideScalarBarOnHide;
252  static bool InheritRepresentationProperties;
253  bool SkipUpdatePipelineBeforeDisplay;
254 };
255 
256 #endif
vtkSMParaViewPipelineControllerWithRendering overrides vtkSMParaViewPipelineController to add support...
virtual bool PostInitializeProxy(vtkSMProxy *proxy)
Final step in proxy initialization.
Controller that encapsulates control logic for typical ParaView applications.
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:152
static vtkSMParaViewPipelineController * New()
virtual void DoMaterialSetup(vtkSMProxy *proxy)
An entry point to load a catalog of OSPRay rendering materials.