initialization helper for a proxy.
More...
#include <vtkSMProxyInitializationHelper.h>
initialization helper for a proxy.
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:
<Proxy ...>
<Hints>
<InitializationHelper class="vtkMyCustomIntializationHelper" />
</Hints>
</Proxy>
Definition at line 44 of file vtkSMProxyInitializationHelper.h.
◆ Superclass
◆ vtkSMProxyInitializationHelper()
vtkSMProxyInitializationHelper::vtkSMProxyInitializationHelper |
( |
| ) |
|
|
protected |
◆ ~vtkSMProxyInitializationHelper()
vtkSMProxyInitializationHelper::~vtkSMProxyInitializationHelper |
( |
| ) |
|
|
protected |
◆ GetClassName()
virtual const char* vtkSMProxyInitializationHelper::GetClassName |
( |
| ) |
|
|
virtual |
◆ IsTypeOf()
static int vtkSMProxyInitializationHelper::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
◆ IsA()
virtual int vtkSMProxyInitializationHelper::IsA |
( |
const char * |
type | ) |
|
|
virtual |
◆ SafeDownCast()
◆ PrintSelf()
void vtkSMProxyInitializationHelper::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
◆ PostInitializeProxy()
virtual void vtkSMProxyInitializationHelper::PostInitializeProxy |
( |
vtkSMProxy * |
proxy, |
|
|
vtkPVXMLElement * |
xml, |
|
|
unsigned long |
initializationTimeStamp |
|
) |
| |
|
pure virtual |
Called during vtkSMParaViewPipelineController::PostInitializeProxy() to initialize a proxy.
- Parameters
-
proxy | : the proxy being initialized. |
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. |
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. |
Implemented in vtkSMPLYWriterProxyInitializationHelper.
The documentation for this class was generated from the following file: