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
|
/*=========================================================================
Program: ParaView
Module: vtkSMProxyInitializationHelper.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.
=========================================================================*/
// .NAME vtkSMProxyInitializationHelper - initialization helper for a proxy.
// .SECTION Description
// vtkSMProxyInitializationHelper is used to add custom initialization logic to
// the initialization of a proxy done by vtkSMParaViewPipelineController.
// Developers can create new subclasses of vtkSMProxyInitializationHelper for
// specific proxy types. vtkSMProxyInitializationHelper will instantiate the
// helper and call PostInitializeProxy() in
// vtkSMParaViewPipelineController::PostInitializeProxy().
//
// Helpers are added to a proxy in the XML configuration as follows:
// \code{.xml}
// <Proxy ...>
// <Hints>
// <InitializationHelper class="vtkMyCustomIntializationHelper" />
// </Hints>
// </Proxy>
// \endcode
#ifndef vtkSMProxyInitializationHelper_h
#define vtkSMProxyInitializationHelper_h
#include "vtkSMObject.h"
class vtkPVXMLElement;
class vtkSMProxy;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMProxyInitializationHelper : public vtkSMObject
{
public:
vtkTypeMacro(vtkSMProxyInitializationHelper, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Called during vtkSMParaViewPipelineController::PostInitializeProxy() to
// initialize a proxy.
// @param proxy : the proxy being initialized.
// @param xml : the XML configuration from this helper from this Hints for the
// proxy. This makes it possible to pass additional configuration
// parameters to the initialization helper.
// @param initializationTimeStamp: the timestamp for the proxy initialization.
// Generally, if a property on the proxy has MTime greater than
// initializationTimeStamp, the initializer should not modify the
// property since it was explicitly set by the user during
// initialization.
virtual void PostInitializeProxy(
vtkSMProxy* proxy, vtkPVXMLElement* xml, unsigned long initializationTimeStamp) = 0;
protected:
vtkSMProxyInitializationHelper();
~vtkSMProxyInitializationHelper();
private:
vtkSMProxyInitializationHelper(const vtkSMProxyInitializationHelper&); // Not implemented
void operator=(const vtkSMProxyInitializationHelper&); // Not implemented
};
#endif
|
