1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*=========================================================================
Program: ParaView
Module: vtkSMProxyClipboard.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkSMProxyClipboard
* @brief 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:
* \li Skips input properties.
* \li Skips properties that are hidden by setting
* vtkSMProperty::PanelVisibility to "never".
* \li 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.
* \li For other vtkSMProxyProperty instances (e.g. LookupTable,
* ScalarOpacityFunction, etc.) on Paste, it tries to locate the requested proxy
* value on the session.
*/
#ifndef vtkSMProxyClipboard_h
#define vtkSMProxyClipboard_h
#include "vtkPVServerManagerDefaultModule.h" //needed for exports
#include "vtkSMObject.h"
#include "vtkSmartPointer.h" // for vtkSmartPointer.
class vtkPVXMLElement;
class vtkSMProxy;
class vtkSMProxyClipboardInternals;
class VTKPVSERVERMANAGERDEFAULT_EXPORT vtkSMProxyClipboard : public vtkSMObject
{
public:
static vtkSMProxyClipboard* New();
vtkTypeMacro(vtkSMProxyClipboard, vtkSMObject);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Put a proxy's state on the clipboard. Return true if the operation was
* successful.
*/
bool Copy(vtkSMProxy* source);
/**
* Returns true of the proxy state on the clipboard can be pasted on to the
* specified \c target. Current implementation doesn't check for the types of the
* proxies. In future, we can make this type-aware or add other criteria.
*/
bool CanPaste(vtkSMProxy* target);
/**
* Paste the state on the clipboard on to the target proxy.
*/
bool Paste(vtkSMProxy* target);
/**
* Clears the clipboard. Same as calling Copy(NULL).
*/
void Clear() { this->Copy(NULL); }
protected:
vtkSMProxyClipboard();
~vtkSMProxyClipboard();
vtkSmartPointer<vtkPVXMLElement> CopiedState;
private:
vtkSMProxyClipboard(const vtkSMProxyClipboard&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMProxyClipboard&) VTK_DELETE_FUNCTION;
vtkSMProxyClipboardInternals* Internals;
};
#endif
|
