Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkSMProxyInitializationHelper Class Referenceabstract

initialization helper for a proxy. More...

#include <vtkSMProxyInitializationHelper.h>

Inheritance diagram for vtkSMProxyInitializationHelper:
Inheritance graph
[legend]
Collaboration diagram for vtkSMProxyInitializationHelper:
Collaboration graph
[legend]

Public Types

typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void PostInitializeProxy (vtkSMProxy *proxy, vtkPVXMLElement *xml, vtkMTimeType initializationTimeStamp)=0
 Called during vtkSMParaViewPipelineController::PostInitializeProxy() to initialize a proxy. More...
 
virtual void RegisterProxy (vtkSMProxy *proxy, vtkPVXMLElement *xml)
 Called during vtkSMParaViewPipelineController::Register. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSMProxyInitializationHelperSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMProxyInitializationHelper ()
 
 ~vtkSMProxyInitializationHelper () override
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

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.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file vtkSMProxyInitializationHelper.h.

Constructor & Destructor Documentation

◆ vtkSMProxyInitializationHelper()

vtkSMProxyInitializationHelper::vtkSMProxyInitializationHelper ( )
protected

◆ ~vtkSMProxyInitializationHelper()

vtkSMProxyInitializationHelper::~vtkSMProxyInitializationHelper ( )
overrideprotected

Member Function Documentation

◆ 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()

static vtkSMProxyInitializationHelper* vtkSMProxyInitializationHelper::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

void vtkSMProxyInitializationHelper::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMXYChartRepresentationInitializationHelper.

◆ PostInitializeProxy()

virtual void vtkSMProxyInitializationHelper::PostInitializeProxy ( vtkSMProxy proxy,
vtkPVXMLElement xml,
vtkMTimeType  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.
initializationTimeStampthe 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 vtkSMCSVProxiesInitializationHelper, vtkSMOMETIFFChannelCalculatorInitializationHelper, vtkSMPLYWriterProxyInitializationHelper, vtkSMXYChartRepresentationInitializationHelper, and vtkSMExtractSelectionProxyInitializationHelper.

◆ RegisterProxy()

virtual void vtkSMProxyInitializationHelper::RegisterProxy ( vtkSMProxy proxy,
vtkPVXMLElement xml 
)
virtual

Called during vtkSMParaViewPipelineController::Register.

*Proxy to register any helper proxies created during by this helper. Default implementation does nothing.

Reimplemented in vtkSMOMETIFFChannelCalculatorInitializationHelper.


The documentation for this class was generated from the following file: