Abstract base class for proxy/property links. More...

#include <vtkSMLink.h>

Inheritance diagram for vtkSMLink:

Collaboration diagram for vtkSMLink:

Public Types
enum	UpdateDirections { NONE = 0, INPUT = 1, OUTPUT = 2 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	RemoveAllLinks ()=0
virtual const vtkSMMessage *	GetFullState ()
virtual void	LoadState (const vtkSMMessage msg, vtkSMProxyLocator locator)

virtual void	SetPropagateUpdateVTKObjects (int)
virtual int	GetPropagateUpdateVTKObjects ()
virtual void	PropagateUpdateVTKObjectsOn ()
virtual void	PropagateUpdateVTKObjectsOff ()

virtual void	SetEnabled (bool)
virtual bool	GetEnabled ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkSMLink *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkSMLink ()
	~vtkSMLink ()
void	PushStateToSession ()
virtual void	UpdateVTKObjects (vtkSMProxy *proxy)=0
virtual void	PropertyModified (vtkSMProxy proxy, const char pname)=0
virtual void	UpdateProperty (vtkSMProxy caller, const char pname)=0
void	ObserveProxyUpdates (vtkSMProxy *proxy)
virtual void	SaveXMLState (const char linkname, vtkPVXMLElement parent)=0
virtual int	LoadXMLState (vtkPVXMLElement linkElement, vtkSMProxyLocator locator)=0
Protected Attributes
vtkCommand *	Observer
int	PropagateUpdateVTKObjects
bool	Enabled
vtkSMMessage *	State
Friends
class	vtkSMLinkObserver
class	vtkSMStateLoader
class	vtkSMSessionProxyManager

Detailed Description

Abstract base class for proxy/property links.

Abstract base class for proxy/property links. Links provide a means to connect two properies(or proxies) together, thus when on is updated, the dependent is also updated accordingly.

Definition at line 35 of file vtkSMLink.h.

Member Enumeration Documentation

enum vtkSMLink::UpdateDirections

Enumerator:

NONE
INPUT
OUTPUT

Definition at line 42 of file vtkSMLink.h.

Constructor & Destructor Documentation

vtkSMLink::vtkSMLink ( ) [protected]

vtkSMLink::~vtkSMLink ( ) [protected]

Member Function Documentation

virtual const char* vtkSMLink::GetClassName ( ) [virtual]

Reimplemented from vtkSMRemoteObject.

Reimplemented in vtkSMProxyLink, vtkSMPropertyLink, and vtkSMCameraLink.

static int vtkSMLink::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkSMRemoteObject.

Reimplemented in vtkSMProxyLink, vtkSMPropertyLink, and vtkSMCameraLink.

virtual int vtkSMLink::IsA ( const char * type ) [virtual]

Reimplemented from vtkSMRemoteObject.

Reimplemented in vtkSMProxyLink, vtkSMPropertyLink, and vtkSMCameraLink.

static vtkSMLink* vtkSMLink::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkSMRemoteObject.

Reimplemented in vtkSMProxyLink, vtkSMPropertyLink, and vtkSMCameraLink.

void vtkSMLink::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkSMRemoteObject.

Reimplemented in vtkSMProxyLink, vtkSMPropertyLink, and vtkSMCameraLink.

virtual void vtkSMLink::SetPropagateUpdateVTKObjects ( int ) [virtual]

This flag determins if UpdateVTKObjects calls are to be propagated. Set to 1 by default.

virtual int vtkSMLink::GetPropagateUpdateVTKObjects ( ) [virtual]

This flag determins if UpdateVTKObjects calls are to be propagated. Set to 1 by default.

virtual void vtkSMLink::PropagateUpdateVTKObjectsOn ( ) [virtual]

This flag determins if UpdateVTKObjects calls are to be propagated. Set to 1 by default.

virtual void vtkSMLink::PropagateUpdateVTKObjectsOff ( ) [virtual]

This flag determins if UpdateVTKObjects calls are to be propagated. Set to 1 by default.

virtual void vtkSMLink::SetEnabled ( bool ) [virtual]

Get/Set if the link is enabled. (true by default).

virtual bool vtkSMLink::GetEnabled ( ) [virtual]

Get/Set if the link is enabled. (true by default).

virtual void vtkSMLink::RemoveAllLinks ( ) [pure virtual]

Remove all links.

Implemented in vtkSMPropertyLink, and vtkSMProxyLink.

virtual const vtkSMMessage* vtkSMLink::GetFullState ( ) [virtual]

This method return the full object state that can be used to create that object from scratch. This method will be used to fill the undo stack. If not overriden this will return NULL.

Reimplemented from vtkSMRemoteObject.

virtual void vtkSMLink::LoadState	(	const vtkSMMessage *	msg,
		vtkSMProxyLocator *	locator
	)		`[virtual]`

This method is used to initialise the object to the given state If the definitionOnly Flag is set to True the proxy won't load the properties values and just setup the new proxy hierarchy with all subproxy globalID set. This allow to split the load process in 2 step to prevent invalid state when property refere to a sub-proxy that does not exist yet.

Reimplemented from vtkSMRemoteObject.

Reimplemented in vtkSMPropertyLink, vtkSMProxyLink, and vtkSMCameraLink.

void vtkSMLink::PushStateToSession ( ) [protected]

When the state has changed we call that method so the state can be shared is any collaboration is involved

virtual void vtkSMLink::UpdateVTKObjects ( vtkSMProxy * proxy ) [protected, pure virtual]

Called when an input proxy is updated (UpdateVTKObjects). Argument is the input proxy.

Implemented in vtkSMPropertyLink, vtkSMProxyLink, and vtkSMCameraLink.

virtual void vtkSMLink::PropertyModified	(	vtkSMProxy *	proxy,
		const char *	pname
	)		`[protected, pure virtual]`

Called when a property of an input proxy is modified. caller:- the input proxy. pname:- name of the property being modified.

Implemented in vtkSMPropertyLink, vtkSMProxyLink, and vtkSMCameraLink.

virtual void vtkSMLink::UpdateProperty	(	vtkSMProxy *	caller,
		const char *	pname
	)		`[protected, pure virtual]`

Called when a property is pushed. caller :- the input proxy. pname :- name of property that was pushed.

Implemented in vtkSMPropertyLink, vtkSMProxyLink, and vtkSMCameraLink.

void vtkSMLink::ObserveProxyUpdates ( vtkSMProxy * proxy ) [protected]

Subclasses call this method to observer events on a INPUT proxy.

virtual void vtkSMLink::SaveXMLState	(	const char *	linkname,
		vtkPVXMLElement *	parent
	)		`[protected, pure virtual]`

Save the state of the link.

Implemented in vtkSMPropertyLink, vtkSMProxyLink, and vtkSMCameraLink.

virtual int vtkSMLink::LoadXMLState	(	vtkPVXMLElement *	linkElement,
		vtkSMProxyLocator *	locator
	)		`[protected, pure virtual]`

Load the link state.

Implemented in vtkSMPropertyLink, and vtkSMProxyLink.

Friends And Related Function Documentation

friend class vtkSMLinkObserver [friend]

Definition at line 111 of file vtkSMLink.h.

friend class vtkSMStateLoader [friend]

Reimplemented from vtkSMRemoteObject.

Definition at line 112 of file vtkSMLink.h.

friend class vtkSMSessionProxyManager [friend]

Definition at line 113 of file vtkSMLink.h.

Member Data Documentation

vtkCommand* vtkSMLink::Observer [protected]

Definition at line 115 of file vtkSMLink.h.

int vtkSMLink::PropagateUpdateVTKObjects [protected]

Definition at line 119 of file vtkSMLink.h.

bool vtkSMLink::Enabled [protected]

Definition at line 121 of file vtkSMLink.h.

vtkSMMessage* vtkSMLink::State [protected]

Definition at line 124 of file vtkSMLink.h.

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

dox/ParaViewCore/ServerManager/vtkSMLink.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation