vtkSMPlotlyJsonExtractWriterProxy.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
2 // SPDX-License-Identifier: BSD-3-Clause
14 #ifndef vtkSMPlotlyJsonExtractWriterProxy_h
15 #define vtkSMPlotlyJsonExtractWriterProxy_h
16 
17 #include "vtkRemotingViewsModule.h" // needed for exports
18 #include "vtkSMExtractWriterProxy.h" // base class
19 #include "vtkSMViewProxy.h" // for member variable
20 
21 class vtkSMViewProxy;
22 
23 class VTKREMOTINGVIEWS_EXPORT vtkSMPlotlyJsonExtractWriterProxy : public vtkSMExtractWriterProxy
24 {
25 public:
28  void PrintSelf(ostream& os, vtkIndent indent) override;
29 
31 
34  vtkSetObjectMacro(View, vtkSMViewProxy);
35  vtkGetObjectMacro(View, vtkSMViewProxy);
37 
39 
42  bool Write(vtkSMExtractsController* extractor) override;
43  bool CanExtract(vtkSMProxy* proxy) override;
44  bool IsExtracting(vtkSMProxy* proxy) override;
45  void SetInput(vtkSMProxy* proxy) override;
46  vtkSMProxy* GetInput() override;
48 protected:
51 
52 private:
54  void operator=(const vtkSMPlotlyJsonExtractWriterProxy&) = delete;
55 
56  vtkSMViewProxy* View = nullptr;
57 };
58 
59 #endif
vtkSMProxy::New
static vtkSMProxy * New()
vtkSMExtractWriterProxy::CanExtract
virtual bool CanExtract(vtkSMProxy *proxy)=0
Returns true if the provided proxy can be extracted/written by this writer.
vtkSMViewProxy.h
vtkSMExtractWriterProxy::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
vtkSMExtractWriterProxy.h
vtkSMProxy
proxy for a VTK object(s) on a server
Definition: vtkSMProxy.h:140
vtkSMExtractWriterProxy::IsExtracting
virtual bool IsExtracting(vtkSMProxy *proxy)=0
Returns true this extract writer proxy is generating and extract from the provided proxy.
vtkSMExtractsController
controller for extract generation
Definition: vtkSMExtractsController.h:45
vtkIndent
vtkSMExtractWriterProxy::GetInput
virtual vtkSMProxy * GetInput()=0
This is convenience method that gets called by vtkSMExtractsController to set the extract writer to e...
vtkSMExtractWriterProxy::Write
virtual bool Write(vtkSMExtractsController *extractor)=0
Generate the extract.
vtkSMExtractWriterProxy::SetInput
virtual void SetInput(vtkSMProxy *proxy)=0
This is convenience method that gets called by vtkSMExtractsController to set the extract writer to e...
vtkSMViewProxy
Superclass for all view proxies.
Definition: vtkSMViewProxy.h:42
vtkSMExtractWriterProxy
abstract class defining extract writer proxy API
Definition: vtkSMExtractWriterProxy.h:19
vtkSMPlotlyJsonExtractWriterProxy
extractor used to extract data from certain views to a json file folowing the plotly-json schema.
Definition: vtkSMPlotlyJsonExtractWriterProxy.h:23