create a link between views, with automatic refresh. More...

#include <vtkSMViewLink.h>

Inheritance diagram for vtkSMViewLink:

Collaboration diagram for vtkSMViewLink:

[legend]

Public Types
typedef vtkSMProxyLink	Superclass

Public Types inherited from vtkSMProxyLink
enum	ExceptionListBehavior : int { BLACKLIST = 0, WHITELIST }

typedef vtkSMLink	Superclass

Public Types inherited from vtkSMLink
enum	UpdateDirections { NONE = 0, INPUT = 1, OUTPUT = 2 }

typedef vtkSMRemoteObject	Superclass

Public Types inherited from vtkSMRemoteObject
typedef vtkSMSessionObject	Superclass

Public Types inherited from vtkSMSessionObject
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

void	AddLinkedProxy (vtkSMProxy *proxy, int updateDir) override
	Reimplemented to check proxy type. More...

void	RemoveLinkedProxy (vtkSMProxy *proxy) override
	Remove a linked proxy. More...

void	EnableCameraLink (bool enable)
	Enable linking of Cameras properties. More...

virtual void	UpdateViews (vtkSMProxy *caller)
	Update all the views linked with OUTPUT direction. More...

Public Member Functions inherited from vtkSMProxyLink
virtual void	LinkProxies (vtkSMProxy proxy1, vtkSMProxy proxy2)
	Utility method to add 2 proxies, both as INPUT and OUTPUT. More...

virtual void	LinkProxyPropertyProxies (vtkSMProxy proxy1, vtkSMProxy proxy2, const char *pname)
	Utility method to link the proxies stored as proxy property of input proxies. More...

vtkSMProxy *	GetLinkedProxy (int index) override
	Get a proxy involved in this link. More...

void	RemoveAllLinks () override
	Remove all links. More...

void	LoadState (const vtkSMMessage msg, vtkSMProxyLocator locator) override
	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. More...

unsigned int	GetNumberOfLinkedObjects () override
	Get the number of proxies that are involved in this link. More...

unsigned int	GetNumberOfLinkedProxies ()
	Get the number of proxies that are involved in this link. More...

int	GetLinkedObjectDirection (int index) override
	Get the direction of a proxy involved in this link (see vtkSMLink::UpdateDirections) More...

int	GetLinkedProxyDirection (int index)
	Get the direction of a proxy involved in this link (see vtkSMLink::UpdateDirections) More...

void	AddException (const char *propertyname)
	It is possible to exclude certain properties from being synchronized by this link. More...

void	RemoveException (const char *propertyname)
	It is possible to exclude certain properties from being synchronized by this link. More...

void	ClearExceptions ()
	It is possible to exclude certain properties from being synchronized by this link. More...

virtual void	SetExceptionBehavior (int)
	Set/Get exception behavior. More...

virtual int	GetExceptionBehavior ()
	Set/Get exception behavior. More...

void	SetExceptionBehaviorToBlacklist ()
	Set/Get exception behavior. More...

void	SetExceptionBehaviorToWhitelist ()
	Set/Get exception behavior. More...

Public Member Functions inherited from vtkSMLink
const vtkSMMessage *	GetFullState () override
	This method returns the full object state that can be used to create the object from scratch. More...

virtual void	SetPropagateUpdateVTKObjects (int)
	This flag determines if UpdateVTKObjects calls are to be propagated. More...

virtual int	GetPropagateUpdateVTKObjects ()
	This flag determines if UpdateVTKObjects calls are to be propagated. More...

virtual void	PropagateUpdateVTKObjectsOn ()
	This flag determines if UpdateVTKObjects calls are to be propagated. More...

virtual void	PropagateUpdateVTKObjectsOff ()
	This flag determines if UpdateVTKObjects calls are to be propagated. More...

virtual void	SetEnabled (bool)
	Get/Set if the link is enabled. More...

virtual bool	GetEnabled ()
	Get/Set if the link is enabled. More...

Public Member Functions inherited from vtkSMRemoteObject
void	SetSession (vtkSMSession *) override
	Override the SetSession so if the object already have an ID we automatically register it to the associated session. More...

bool	HasGlobalID ()
	Allow the user to test if the RemoteObject has already a GlobalID without assigning a new one to it. More...

virtual void	EnableLocalPushOnly ()
	Allow to switch off any push of state change to the server for that particular object. More...

virtual void	DisableLocalPushOnly ()
	Enable the given remote object to communicate its state normally to the server location. More...

virtual bool	IsLocalPushOnly ()
	Let the session be aware that even if the Location is client only, the message should not be send to the server for a general broadcast. More...

virtual void	SetLocation (vtkTypeUInt32)
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkTypeUInt32	GetLocation ()
	Get/Set the location where the underlying VTK-objects are created. More...

virtual vtkTypeUInt32	GetGlobalID ()
	Get the global unique id for this object. More...

const char *	GetGlobalIDAsString ()
	Get the global unique id for this object. More...

virtual void	PrototypeOn ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

virtual void	PrototypeOff ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

bool	IsPrototype ()
	Allow user to set the remote object to be discard for Undo/Redo action. More...

virtual void	SetPrototype (bool)
	Allow user to set the remote object to be discard for Undo/Redo action. More...

Public Member Functions inherited from vtkSMSessionObject
virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Return the corresponding ProxyManager if any. More...

virtual vtkSMSession *	GetSession ()
	Get/Set the session on wihch this object exists. 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 vtkSMViewLink *	New ()

static int	IsTypeOf (const char *type)

static vtkSMViewLink *	SafeDownCast (vtkObject *o)

static void	UpdateViewCallback (vtkObject caller, unsigned long eid, void clientData, void *callData)
	Callback to render output views. More...

Static Public Member Functions inherited from vtkSMProxyLink
static vtkSMProxyLink *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxyLink *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMLink
static int	IsTypeOf (const char *type)

static vtkSMLink *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMRemoteObject
static int	IsTypeOf (const char *type)

static vtkSMRemoteObject *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkSMSessionObject
static vtkSMSessionObject *	New ()

static int	IsTypeOf (const char *type)

static vtkSMSessionObject *	SafeDownCast (vtkObject *o)

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

	~vtkSMViewLink () override

std::string	GetXMLTagName () override
	Override to ajust to this class name. More...

void	UpdateVTKObjects (vtkSMProxy *proxy) override
	Called when an input proxy is updated (UpdateEvent). More...

Protected Member Functions inherited from vtkSMProxyLink
	vtkSMProxyLink ()

	~vtkSMProxyLink () override

void	PropertyModified (vtkSMProxy proxy, const char pname) override
	Called when a property of an input proxy is modified. More...

void	UpdateProperty (vtkSMProxy caller, const char pname) override
	Called when a property is pushed. More...

void	SaveXMLState (const char linkname, vtkPVXMLElement parent) override
	Save the state of the link. More...

int	LoadXMLState (vtkPVXMLElement linkElement, vtkSMProxyLocator locator) override
	Load the link state. More...

void	UpdateState () override
	Update the internal protobuf state. More...

Protected Member Functions inherited from vtkSMLink
	vtkSMLink ()

	~vtkSMLink () override

void	PushStateToSession ()
	When the state has changed we call that method so the state can be shared if any collaboration is involved. More...

void	ObserveProxyUpdates (vtkSMProxy *proxy)
	Subclasses call this method to observer events on a INPUT proxy. More...

Protected Member Functions inherited from vtkSMRemoteObject
	vtkSMRemoteObject ()
	Default constructor. More...

	~vtkSMRemoteObject () override
	Destructor. More...

void	PushState (vtkSMMessage *msg)
	Subclasses can call this method to send a message to its state object on the server processes specified. More...

bool	PullState (vtkSMMessage *msg)
	Subclasses can call this method to pull the state from the state-object on the server processes specified. More...

void	SetGlobalID (vtkTypeUInt32 guid)
	Set the GlobalUniqueId. More...

vtkTypeUInt32	GetFilteredLocation ()

Protected Member Functions inherited from vtkSMSessionObject
	vtkSMSessionObject ()

	~vtkSMSessionObject () 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 &)

Protected Attributes
std::map< vtkSMProxy *, vtkSmartPointer< vtkCallbackCommand > >	RenderObservers

bool	Updating = false

bool	UpdateViewsOnEndEvent = true

Protected Attributes inherited from vtkSMLink
vtkCommand *	Observer

int	PropagateUpdateVTKObjects

bool	Enabled

vtkSMMessage *	State

Protected Attributes inherited from vtkSMRemoteObject
vtkTypeUInt32	GlobalID

vtkTypeUInt32	Location

bool	Prototype

bool	ClientOnlyLocationFlag

Protected Attributes inherited from vtkSMSessionObject
vtkWeakPointer< vtkSMSession >	Session
	Identifies the session id to which this object is related. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

create a link between views, with automatic refresh.

vtkSMViewLink is a proxy link to synchronize views properties.

The "Representations" property is excluded by default as representations should not be duplicated in different views.

Camera properties can be excluded fault from the link, see EnableCameraLink.

Definition at line 23 of file vtkSMViewLink.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMProxyLink vtkSMViewLink::Superclass

Definition at line 27 of file vtkSMViewLink.h.

Constructor & Destructor Documentation

◆ vtkSMViewLink()

vtkSMViewLink::vtkSMViewLink ( )

protected

◆ ~vtkSMViewLink()

vtkSMViewLink::~vtkSMViewLink ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMViewLink* vtkSMViewLink::New ( )

static

◆ GetClassName()

virtual const char* vtkSMViewLink::GetClassName ( )

virtual

Reimplemented from vtkSMProxyLink.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMProxyLink.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkSMProxyLink.

◆ AddLinkedProxy()

void vtkSMViewLink::AddLinkedProxy	(	vtkSMProxy *	proxy,
		int	updateDir
	)

overridevirtual

Reimplemented to check proxy type.

Reimplemented from vtkSMProxyLink.

◆ RemoveLinkedProxy()

void vtkSMViewLink::RemoveLinkedProxy ( vtkSMProxy * proxy )

overridevirtual

Remove a linked proxy.

Reimplemented from vtkSMProxyLink.

◆ EnableCameraLink()

void vtkSMViewLink::EnableCameraLink ( bool enable )

Enable linking of Cameras properties.

Uses vtkSMCameraLink to get list of properties to create or remove exception.

◆ UpdateViewCallback()

static void vtkSMViewLink::UpdateViewCallback	(	vtkObject *	caller,
		unsigned long	eid,
		void *	clientData,
		void *	callData
	)

static

Callback to render output views.

This is useful to update render view when camera changes.

◆ UpdateViews()

virtual void vtkSMViewLink::UpdateViews ( vtkSMProxy * caller )

virtual

Update all the views linked with OUTPUT direction.

◆ GetXMLTagName()

std::string vtkSMViewLink::GetXMLTagName ( )

inlineoverrideprotectedvirtual

Override to ajust to this class name.

Reimplemented from vtkSMProxyLink.

Definition at line 64 of file vtkSMViewLink.h.

◆ UpdateVTKObjects()

void vtkSMViewLink::UpdateVTKObjects ( vtkSMProxy * proxy )

overrideprotectedvirtual

Called when an input proxy is updated (UpdateEvent).

Argument is the input proxy. Reimplemented to force an update on the view.

Reimplemented from vtkSMProxyLink.

Member Data Documentation

◆ RenderObservers

std::map<vtkSMProxy*, vtkSmartPointer<vtkCallbackCommand> > vtkSMViewLink::RenderObservers

protected

Definition at line 73 of file vtkSMViewLink.h.

◆ Updating

bool vtkSMViewLink::Updating = false

protected

Definition at line 75 of file vtkSMViewLink.h.

◆ UpdateViewsOnEndEvent

bool vtkSMViewLink::UpdateViewsOnEndEvent = true

protected

Definition at line 76 of file vtkSMViewLink.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkSMViewLink.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMViewLink()

◆ ~vtkSMViewLink()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ AddLinkedProxy()

◆ RemoveLinkedProxy()

◆ EnableCameraLink()

◆ UpdateViewCallback()

◆ UpdateViews()

◆ GetXMLTagName()

◆ UpdateVTKObjects()

Member Data Documentation

◆ RenderObservers

◆ Updating

◆ UpdateViewsOnEndEvent