vtkSMParaViewPipelineController Class Reference

Controller that encapsulates control logic for typical ParaView applications. More...

#include <vtkSMParaViewPipelineController.h>

Inheritance diagram for vtkSMParaViewPipelineController:

Collaboration diagram for vtkSMParaViewPipelineController:

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 bool	InitializeSession (vtkSMSession *session)
	Call this method to setup a branch new session with state considered essential for ParaView session. More...
virtual vtkSMProxy *	FindTimeKeeper (vtkSMSession *session)
	Returns the TimeKeeper proxy associated with the session. More...
virtual vtkSMProxy *	FindMaterialLibrary (vtkSMSession *session)
	Returns the MaterialLibrary proxy associated with the session. More...
virtual bool	PreInitializeProxy (vtkSMProxy *proxy)
	Pre-initializes a proxy i.e. More...
virtual bool	PostInitializeProxy (vtkSMProxy *proxy)
	Final step in proxy initialization. More...
bool	InitializeProxy (vtkSMProxy *proxy)
	Convenience method to call PreInitializeProxy and PostInitializeProxy. More...
virtual bool	FinalizeProxy (vtkSMProxy *proxy)
	Cleans up any helper proxies registered for the proxy in PreInitializeProxy/PostInitializeProxy. More...
virtual bool	RegisterPipelineProxy (vtkSMProxy *proxy, const char *proxyname)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register a pipeline proxy with the proxy manager. More...
virtual bool	RegisterPipelineProxy (vtkSMProxy *proxy)
virtual bool	UnRegisterPipelineProxy (vtkSMProxy *proxy)
	Unregisters a pipeline proxy. More...
virtual bool	RegisterViewProxy (vtkSMProxy *proxy)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register a view proxy with the proxy manager. More...
virtual bool	RegisterViewProxy (vtkSMProxy *proxy, const char *proxyname)
virtual bool	UnRegisterViewProxy (vtkSMProxy *proxy, bool unregister_representations=true)
	Inverse of RegisterViewProxy. More...
virtual bool	UnRegisterRepresentationProxy (vtkSMProxy *proxy)
	Unregisters a representation proxy. More...
virtual bool	RegisterColorTransferFunctionProxy (vtkSMProxy *proxy, const char *proxyname)
	Registration method for color transfer function proxies to be used after PreInitializeProxy() and PostInitializeProxy() calls. More...
virtual bool	RegisterColorTransferFunctionProxy (vtkSMProxy *proxy)
virtual bool	RegisterOpacityTransferFunction (vtkSMProxy *proxy, const char *proxyname)
	Registration method for opacity transfer function proxies. More...
virtual bool	RegisterOpacityTransferFunction (vtkSMProxy *proxy)
virtual bool	RegisterTransferFunction2D (vtkSMProxy *proxy, const char *proxyname)
	Registration method for 2D transfer function proxies. More...
virtual bool	RegisterTransferFunction2D (vtkSMProxy *proxy)
virtual bool	RegisterLightProxy (vtkSMProxy *proxy, vtkSMProxy *view, const char *proxyname)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register a light proxy with the proxy manager. More...
virtual bool	RegisterLightProxy (vtkSMProxy *proxy, vtkSMProxy *view)
virtual bool	RegisterTextureProxy (vtkSMProxy *proxy, const char *filename)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register a texture proxy with the proxy manager. More...
virtual bool	RegisterTextureProxy (vtkSMProxy *proxy, const char *trivialProducerKeyName, const char *proxyname)
virtual bool	RegisterExtractorProxy (vtkSMProxy *proxy, const char *proxyname)
	Registers an extractor. More...
virtual bool	RegisterExtractorProxy (vtkSMProxy *proxy)
virtual vtkSMProxy *	FindAnimationScene (vtkSMSession *session)
	Returns the animation scene, if any. More...
virtual vtkSMProxy *	GetAnimationScene (vtkSMSession *session)
	Returns the animation scene for the session. More...
virtual vtkSMProxy *	FindTimeAnimationTrack (vtkSMProxy *scene)
	Return the animation track for time, if any. More...
virtual vtkSMProxy *	GetTimeAnimationTrack (vtkSMProxy *scene)
	Return the animation track for time. More...
virtual bool	RegisterAnimationProxy (vtkSMProxy *proxy)
	Use this method after PreInitializeProxy() and PostInitializeProxy() to register an animation proxy with the proxy manager. More...
virtual bool	UnRegisterAnimationProxy (vtkSMProxy *proxy)
	Inverse of RegisterAnimationProxy. More...
virtual void	UpdateSettingsProxies (vtkSMSession *session)
	Initializes and registers proxies in the "settings" group that haven't been already. More...
virtual bool	UnRegisterProxy (vtkSMProxy *proxy)
	A catch-all method do cleanup and unregister any proxies that were registered using Register..Proxy() APIs on this class. More...
virtual bool	RegisterRepresentationProxy (vtkSMProxy *proxy)
	Registration method for representations to be used after PreInitializeProxy() and PostInitializeProxy(). More...
virtual bool	RegisterRepresentationProxy (vtkSMProxy *proxy, const char *proxyname)
	Registration method for representations to be used after PreInitializeProxy() and PostInitializeProxy(). 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)
vtkCommand *	GetCommand (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)
vtkCommand *	GetCommand (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 vtkSMParaViewPipelineController *	New ()
static int	IsTypeOf (const char *type)
static vtkSMParaViewPipelineController *	SafeDownCast (vtkObject *o)
static std::string	GetHelperProxyGroupName (vtkSMProxy *)
	For a given proxy returns the name of the group used for helper proxies. More...
Static Public Member Functions inherited from vtkSMObject
static vtkSMObject *	New ()
static int	IsTypeOf (const char *type)
static vtkSMObject *	SafeDownCast (vtkObject *o)
static std::string	CreatePrettyLabel (const std::string &name)
	Return a well-formated label using provided name by adding spaces between lower cases and upper cases: More...
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
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 vtkObjectBase *	New ()
static vtkObjectBase *	New ()

Protected Member Functions
	vtkSMParaViewPipelineController ()
	~vtkSMParaViewPipelineController () override
vtkSMProxy *	FindProxy (vtkSMSessionProxyManager *pxm, const char *reggroup, const char *xmlgroup, const char *xmltype)
	Find proxy of the group type (xmlgroup, xmltype) registered under a particular group (reggroup). More...
virtual bool	SetupGlobalPropertiesLinks (vtkSMProxy *proxy)
	Setup global properties links based on hints for properties in the XML. More...
virtual bool	CreateAnimationHelpers (vtkSMProxy *proxy)
	To help animation representation properties such as visibility, opacity, we create animation helpers. More...
virtual bool	UnRegisterDependencies (vtkSMProxy *proxy)
	Unregisters know proxy dependencies that must be removed when the proxy is to be deleted e.g animation cues, representations, etc. More...
vtkMTimeType	GetInitializationTime (vtkSMProxy *)
	Returns the initialization timestamp for the proxy, if available. More...
void	ProcessInitializationHelperRegistration (vtkSMProxy *)
	If the proxy has initialization helpers, let those classes also handle registration tasks, if any. More...
virtual bool	CreateProxiesForProxyListDomains (vtkSMProxy *proxy)
	Creates new proxies for proxies referred in vtkSMProxyListDomain for any of the properties for the given proxy. More...
virtual void	RegisterProxiesForProxyListDomains (vtkSMProxy *proxy)
	Creates new proxies for proxies referred in vtkSMProxyListDomain for any of the properties for the given proxy. More...
void	ProcessInitializationHelper (vtkSMProxy *, vtkMTimeType initializationTimeStamp)
	Proxies can specify custom initialization using XML hints. More...
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

Controller that encapsulates control logic for typical ParaView applications.

ParaView's ServerManager, together with it's proxies and properties provides a mechanism to create visualization and data processing pipelines. However, for a complex application like ParaView, there is considerable control logic to manage these proxies, set them up, etc. for common operations supported by the application. vtkSMParaViewPipelineController provides us a mechanism to encapsulate just control logic with ability to customize and extend for custom applications, similar to ParaView.

vtkSMParaViewPipelineController has no state of itself. When needed, one should simply create an instance of vtkSMParaViewPipelineController and release it once done.

vtkSMParaViewPipelineController uses the vtkObjectFactory mechanism. Custom application developers can provide subclasses and override the behaviour (see vtkSMParaViewPipelineControllerWithRender).

For an example of using vtkSMParaViewPipelineController in your application, see Remoting/Views/Testing/Cxx/TestParaViewPipelineController.cxx.

Definition at line 40 of file vtkSMParaViewPipelineController.h.

Member Typedef Documentation

Superclass

typedef vtkSMObject vtkSMParaViewPipelineController::Superclass

Definition at line 44 of file vtkSMParaViewPipelineController.h.

Constructor & Destructor Documentation

vtkSMParaViewPipelineController()

vtkSMParaViewPipelineController::vtkSMParaViewPipelineController ( )

protected

~vtkSMParaViewPipelineController()

vtkSMParaViewPipelineController::~vtkSMParaViewPipelineController ( )

overrideprotected

Member Function Documentation

New()

static vtkSMParaViewPipelineController* vtkSMParaViewPipelineController::New ( )

static

GetClassName()

virtual const char* vtkSMParaViewPipelineController::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMParaViewPipelineControllerWithRendering.

IsTypeOf()

static int vtkSMParaViewPipelineController::IsTypeOf ( const char *  type )

static

IsA()

virtual int vtkSMParaViewPipelineController::IsA ( const char *  type )

virtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMParaViewPipelineControllerWithRendering.

SafeDownCast()

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

static

PrintSelf()

void vtkSMParaViewPipelineController::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Reimplemented from vtkSMObject.

Reimplemented in vtkSMParaViewPipelineControllerWithRendering.

InitializeSession()

virtual bool vtkSMParaViewPipelineController::InitializeSession ( vtkSMSession *  session )

virtual

Call this method to setup a branch new session with state considered essential for ParaView session.

Returns true on success.

FindTimeKeeper()

virtual vtkSMProxy* vtkSMParaViewPipelineController::FindTimeKeeper ( vtkSMSession *  session )

virtual

Returns the TimeKeeper proxy associated with the session.

FindMaterialLibrary()

virtual vtkSMProxy* vtkSMParaViewPipelineController::FindMaterialLibrary ( vtkSMSession *  session )

virtual

Returns the MaterialLibrary proxy associated with the session.

PreInitializeProxy()

virtual bool vtkSMParaViewPipelineController::PreInitializeProxy ( vtkSMProxy *  proxy )

virtual

Pre-initializes a proxy i.e.

prepares the proxy for initialization. One should call this before changing any properties on the proxy. We load the property values from XML defaults as well as user-preferences here.

PostInitializeProxy()

virtual bool vtkSMParaViewPipelineController::PostInitializeProxy ( vtkSMProxy *  proxy )

virtual

Final step in proxy initialization.

When this method is called, all essential properties on the proxy (such as inputs for filters, or filename on readers) are assumed to be set up so that domains can be updated. This method setups up property values for those properties that weren't modified since the PreInitializeProxy() using the domains, if possible. This enables the application to select data-specific default values. NOTE: This method does not register the proxy with the proxy manager. It may, however register any helper proxies created for this proxy.

Reimplemented in vtkSMParaViewPipelineControllerWithRendering.

InitializeProxy()

bool vtkSMParaViewPipelineController::InitializeProxy ( vtkSMProxy *  proxy )

inline

Convenience method to call PreInitializeProxy and PostInitializeProxy.

Definition at line 86 of file vtkSMParaViewPipelineController.h.

FinalizeProxy()

virtual bool vtkSMParaViewPipelineController::FinalizeProxy ( vtkSMProxy *  proxy )

virtual

Cleans up any helper proxies registered for the proxy in PreInitializeProxy/PostInitializeProxy.

Similar to PreInitializeProxy/PostInitializeProxy methods, this doesn't affect the proxy manager registration state for the proxy itself.

RegisterPipelineProxy() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterPipelineProxy ( vtkSMProxy *  proxy, const char *  proxyname  )

virtual

Use this method after PreInitializeProxy() and PostInitializeProxy() to register a pipeline proxy with the proxy manager.

This method does additional updates required for pipeline proxies such as registering the proxy with the TimeKeeper, creating additional helper proxies for enabling representation animations, and updating the active-source. This method will register the proxy in an appropriate group so that the application becomes aware of it. One can optionally pass in the registration name to use. Otherwise, this code will come up with a unique name. Caveat: while pipeline proxies are generally registered under the "sources" group, there's one exception: sources that produce vtkSelection. ParaView treats them specially and registers them under "selection_sources".

RegisterPipelineProxy() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterPipelineProxy ( vtkSMProxy *  proxy )

inlinevirtual

Definition at line 116 of file vtkSMParaViewPipelineController.h.

UnRegisterPipelineProxy()

virtual bool vtkSMParaViewPipelineController::UnRegisterPipelineProxy ( vtkSMProxy *  proxy )

virtual

Unregisters a pipeline proxy.

This is the inverse of RegisterPipelineProxy() and hence unsets the active source if the active source if this proxy, unregisters the proxy with the TimeKeeper etc. Users can use either this method or the catch-all vtkSMParaViewPipelineController::UnRegisterProxy() method which determines the type of the proxy and then calls the appropriate method.

RegisterViewProxy() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterViewProxy ( vtkSMProxy *  proxy )

inlinevirtual

Use this method after PreInitializeProxy() and PostInitializeProxy() to register a view proxy with the proxy manager.

This will also perform any additional setups as needed e.g. registering the view with the animation scene and the timer keeper.

Definition at line 140 of file vtkSMParaViewPipelineController.h.

RegisterViewProxy() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterViewProxy ( vtkSMProxy *  proxy, const char *  proxyname  )

virtual

UnRegisterViewProxy()

virtual bool vtkSMParaViewPipelineController::UnRegisterViewProxy ( vtkSMProxy *  proxy, bool  unregister_representations = true  )

virtual

Inverse of RegisterViewProxy.

Users can use either this method or the catch-all vtkSMParaViewPipelineController::UnRegisterProxy() method which determines the type of the proxy and then calls the appropriate method. If the optional argument, unregister_representations, is false (default is true), then this method will skip the unregistering of representations. Default behaviour is to unregister all representations too.

RegisterRepresentationProxy() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterRepresentationProxy ( vtkSMProxy *  proxy )

inlinevirtual

Registration method for representations to be used after PreInitializeProxy() and PostInitializeProxy().

Register the proxy under the appropriate group.

Reimplemented in vtkSMParaViewPipelineControllerWithRendering.

Definition at line 163 of file vtkSMParaViewPipelineController.h.

RegisterRepresentationProxy() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterRepresentationProxy ( vtkSMProxy *  proxy, const char *  proxyname  )

virtual

Registration method for representations to be used after PreInitializeProxy() and PostInitializeProxy().

Register the proxy under the appropriate group.

UnRegisterRepresentationProxy()

virtual bool vtkSMParaViewPipelineController::UnRegisterRepresentationProxy ( vtkSMProxy *  proxy )

virtual

Unregisters a representation proxy.

Users can use either this method or the catch-all vtkSMParaViewPipelineController::UnRegisterProxy() method which determines the type of the proxy and then calls the appropriate method.

RegisterColorTransferFunctionProxy() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterColorTransferFunctionProxy ( vtkSMProxy *  proxy, const char *  proxyname  )

virtual

Registration method for color transfer function proxies to be used after PreInitializeProxy() and PostInitializeProxy() calls.

RegisterColorTransferFunctionProxy() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterColorTransferFunctionProxy ( vtkSMProxy *  proxy )

inlinevirtual

Definition at line 186 of file vtkSMParaViewPipelineController.h.

RegisterOpacityTransferFunction() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterOpacityTransferFunction ( vtkSMProxy *  proxy, const char *  proxyname  )

virtual

Registration method for opacity transfer function proxies.

RegisterOpacityTransferFunction() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterOpacityTransferFunction ( vtkSMProxy *  proxy )

inlinevirtual

Definition at line 195 of file vtkSMParaViewPipelineController.h.

RegisterTransferFunction2D() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterTransferFunction2D ( vtkSMProxy *  proxy, const char *  proxyname  )

virtual

Registration method for 2D transfer function proxies.

RegisterTransferFunction2D() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterTransferFunction2D ( vtkSMProxy *  proxy )

inlinevirtual

Definition at line 204 of file vtkSMParaViewPipelineController.h.

RegisterLightProxy() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterLightProxy ( vtkSMProxy *  proxy, vtkSMProxy *  view, const char *  proxyname  )

virtual

Use this method after PreInitializeProxy() and PostInitializeProxy() to register a light proxy with the proxy manager.

This will also perform needed python tracing.

RegisterLightProxy() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterLightProxy ( vtkSMProxy *  proxy, vtkSMProxy *  view  )

inlinevirtual

Definition at line 215 of file vtkSMParaViewPipelineController.h.

RegisterTextureProxy() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterTextureProxy ( vtkSMProxy *  proxy, const char *  filename  )

virtual

Use this method after PreInitializeProxy() and PostInitializeProxy() to register a texture proxy with the proxy manager.

This will also perform needed python tracing.

RegisterTextureProxy() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterTextureProxy ( vtkSMProxy *  proxy, const char *  trivialProducerKeyName, const char *  proxyname  )

virtual

RegisterExtractorProxy() [1/2]

virtual bool vtkSMParaViewPipelineController::RegisterExtractorProxy ( vtkSMProxy *  proxy, const char *  proxyname  )

virtual

Registers an extractor.

RegisterExtractorProxy() [2/2]

virtual bool vtkSMParaViewPipelineController::RegisterExtractorProxy ( vtkSMProxy *  proxy )

inlinevirtual

Definition at line 236 of file vtkSMParaViewPipelineController.h.

FindAnimationScene()

virtual vtkSMProxy* vtkSMParaViewPipelineController::FindAnimationScene ( vtkSMSession *  session )

virtual

Returns the animation scene, if any.

Returns nullptr if none exists.

GetAnimationScene()

virtual vtkSMProxy* vtkSMParaViewPipelineController::GetAnimationScene ( vtkSMSession *  session )

virtual

Returns the animation scene for the session.

If none exists, a new one will be created. This may returns nullptr if animation scene proxy is not available in the session.

FindTimeAnimationTrack()

virtual vtkSMProxy* vtkSMParaViewPipelineController::FindTimeAnimationTrack ( vtkSMProxy *  scene )

virtual

Return the animation track for time, if any.

Returns nullptr if none exists.

GetTimeAnimationTrack()

virtual vtkSMProxy* vtkSMParaViewPipelineController::GetTimeAnimationTrack ( vtkSMProxy *  scene )

virtual

Return the animation track for time.

If none exists, a new one will be created. Returns nullptr if the proxy is not available in the session.

RegisterAnimationProxy()

virtual bool vtkSMParaViewPipelineController::RegisterAnimationProxy ( vtkSMProxy *  proxy )

virtual

Use this method after PreInitializeProxy() and PostInitializeProxy() to register an animation proxy with the proxy manager.

UnRegisterAnimationProxy()

virtual bool vtkSMParaViewPipelineController::UnRegisterAnimationProxy ( vtkSMProxy *  proxy )

virtual

Inverse of RegisterAnimationProxy.

Also unregisters cues if proxy is scene, keyframes if proxy is a cue, etc. Users can use either this method or the catch-all vtkSMParaViewPipelineController::UnRegisterProxy() method which determines the type of the proxy and then calls the appropriate method.

UpdateSettingsProxies()

virtual void vtkSMParaViewPipelineController::UpdateSettingsProxies ( vtkSMSession *  session )

virtual

Initializes and registers proxies in the "settings" group that haven't been already.

This may be called whenever a new settings proxy definition becomes available, say, after loading a plugin.

UnRegisterProxy()

virtual bool vtkSMParaViewPipelineController::UnRegisterProxy ( vtkSMProxy *  proxy )

virtual

A catch-all method do cleanup and unregister any proxies that were registered using Register..Proxy() APIs on this class.

It determines what known types the "proxy" is, i.e. is it a view, or pipeline, or representation etc., and then calls the appropriate UnRegister...Proxy() method.

GetHelperProxyGroupName()

static std::string vtkSMParaViewPipelineController::GetHelperProxyGroupName ( vtkSMProxy *  )

static

For a given proxy returns the name of the group used for helper proxies.

FindProxy()

vtkSMProxy* vtkSMParaViewPipelineController::FindProxy ( vtkSMSessionProxyManager *  pxm, const char *  reggroup, const char *  xmlgroup, const char *  xmltype  )

protected

Find proxy of the group type (xmlgroup, xmltype) registered under a particular group (reggroup).

Returns the first proxy found, if any.

CreateProxiesForProxyListDomains()

virtual bool vtkSMParaViewPipelineController::CreateProxiesForProxyListDomains ( vtkSMProxy *  proxy )

protectedvirtual

Creates new proxies for proxies referred in vtkSMProxyListDomain for any of the properties for the given proxy.

RegisterProxiesForProxyListDomains()

virtual void vtkSMParaViewPipelineController::RegisterProxiesForProxyListDomains ( vtkSMProxy *  proxy )

protectedvirtual

Creates new proxies for proxies referred in vtkSMProxyListDomain for any of the properties for the given proxy.

SetupGlobalPropertiesLinks()

virtual bool vtkSMParaViewPipelineController::SetupGlobalPropertiesLinks ( vtkSMProxy *  proxy )

protectedvirtual

Setup global properties links based on hints for properties in the XML.

CreateAnimationHelpers()

virtual bool vtkSMParaViewPipelineController::CreateAnimationHelpers ( vtkSMProxy *  proxy )

protectedvirtual

To help animation representation properties such as visibility, opacity, we create animation helpers.

UnRegisterDependencies()

virtual bool vtkSMParaViewPipelineController::UnRegisterDependencies ( vtkSMProxy *  proxy )

protectedvirtual

Unregisters know proxy dependencies that must be removed when the proxy is to be deleted e.g animation cues, representations, etc.

GetInitializationTime()

vtkMTimeType vtkSMParaViewPipelineController::GetInitializationTime ( vtkSMProxy *  )

protected

Returns the initialization timestamp for the proxy, if available.

Useful for subclasses to determine which properties were modified since initialization.

ProcessInitializationHelper()

void vtkSMParaViewPipelineController::ProcessInitializationHelper ( vtkSMProxy *  , vtkMTimeType  initializationTimeStamp  )

protected

Proxies can specify custom initialization using XML hints.

This method calls those initialization helpers, if any.

ProcessInitializationHelperRegistration()

void vtkSMParaViewPipelineController::ProcessInitializationHelperRegistration ( vtkSMProxy *  )

protected

If the proxy has initialization helpers, let those classes also handle registration tasks, if any.

This is called in RegisterProxy.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMParaViewPipelineController.h