helper class to help copy/paste properties on proxies. More...

#include <vtkSMProxyClipboard.h>

Inheritance diagram for vtkSMProxyClipboard:

Collaboration diagram for vtkSMProxyClipboard:

[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

bool	Copy (vtkSMProxy *source)
	Put a proxy's state on the clipboard. More...

bool	CanPaste (vtkSMProxy *target)
	Returns true of the proxy state on the clipboard can be pasted on to the specified `target`. More...

bool	Paste (vtkSMProxy *target)
	Paste the state on the clipboard on to the target proxy. More...

void	Clear ()
	Clears the clipboard. More...

Public Member Functions inherited from vtkSMObject
void	PrintSelf (ostream &os, vtkIndent indent) override

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 vtkSMProxyClipboard *	New ()

static int	IsTypeOf (const char *type)

static vtkSMProxyClipboard *	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 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
	vtkSMProxyClipboard ()

	~vtkSMProxyClipboard () 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
vtkSmartPointer< vtkPVXMLElement >	CopiedState

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

helper class to help copy/paste properties on proxies.

vtkSMProxyClipboard is a helper class used to enable copy/paste for properties on proxies. Copy/Paste is more that simply copying values from a proxy to another (for which one should simply use vtkSMProxy::Copy()). This has several extra smarts including the following:

Skips input properties.
Skips properties that are hidden by setting vtkSMProperty::PanelVisibility to "never".
Specially handles properties with vtkSMProxyListDomain to select the same type of proxy from the target domain when pasting and then loading the state for the value proxy separately.
For other vtkSMProxyProperty instances (e.g. LookupTable, ScalarOpacityFunction, etc.) on Paste, it tries to locate the requested proxy value on the session.

Definition at line 46 of file vtkSMProxyClipboard.h.

Member Typedef Documentation

◆ Superclass

typedef vtkSMObject vtkSMProxyClipboard::Superclass

Definition at line 50 of file vtkSMProxyClipboard.h.

Constructor & Destructor Documentation

◆ vtkSMProxyClipboard()

vtkSMProxyClipboard::vtkSMProxyClipboard ( )

protected

◆ ~vtkSMProxyClipboard()

vtkSMProxyClipboard::~vtkSMProxyClipboard ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSMProxyClipboard* vtkSMProxyClipboard::New ( )

static

◆ GetClassName()

virtual const char* vtkSMProxyClipboard::GetClassName ( )

virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ Copy()

bool vtkSMProxyClipboard::Copy ( vtkSMProxy * source )

Put a proxy's state on the clipboard.

Return true if the operation was successful.

◆ CanPaste()

bool vtkSMProxyClipboard::CanPaste ( vtkSMProxy * target )

Returns true of the proxy state on the clipboard can be pasted on to the specified target.

Current implementation doesn't check for the types of the proxies. In future, we can make this type-aware or add other criteria.

◆ Paste()

bool vtkSMProxyClipboard::Paste ( vtkSMProxy * target )

Paste the state on the clipboard on to the target proxy.

◆ Clear()

void vtkSMProxyClipboard::Clear ( void )

inline

Clears the clipboard.

Same as calling Copy(NULL).

Definition at line 74 of file vtkSMProxyClipboard.h.

Member Data Documentation

◆ CopiedState

vtkSmartPointer<vtkPVXMLElement> vtkSMProxyClipboard::CopiedState

protected

Definition at line 80 of file vtkSMProxyClipboard.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Misc/vtkSMProxyClipboard.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSMProxyClipboard()

◆ ~vtkSMProxyClipboard()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Copy()

◆ CanPaste()

◆ Paste()

◆ Clear()

Member Data Documentation

◆ CopiedState