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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*=========================================================================
Program: ParaView
Module: vtkSMGlobalPropertiesProxy.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 vtkSMGlobalPropertiesProxy
* @brief proxy that adds support for linking
* properties with other proxies designed for use-cases like color-palettes.
*
* vtkSMGlobalPropertiesProxy can be thought of as a proxy which provides API to
* link its properties with any arbitrary proxy unidirectionally, so that if the
* property value on this proxy changes, the linked property on every other
* proxy is updated. However if the linked property (or target property) is
* modified externally, then the link is automatically broken.
*
* This is suitable adding ability for color palettes. Using XML hints in the
* proxy definition, one can write application code that setups links with a
* proxy and the color palette proxy (as done in
* vtkSMParaViewPipelineController). Now as long as the user doesn't modify
* the linked properties, the color palette can be changed and it will reflect
* on all linked properties.
*
* vtkSMParaViewPipelineController uses the property level hint
* \c \<GlobalPropertyLink/\> to define such links e.g.
* \code{.xml}
* <DoubleVectorProperty name="Background" ... >
* ...
* <Hints>
* <GlobalPropertyLink type="ColorPalette" property="BackgroundColor" />
* </Hints>
* </DoubleVectorProperty>
* \endcode
*
* While vtkSMParaViewPipelineController currently only respects
* hints on the property, we can in future add support for respecting hints at
* the proxy level if needed.
*/
#ifndef vtkSMGlobalPropertiesProxy_h
#define vtkSMGlobalPropertiesProxy_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMProxy.h"
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMGlobalPropertiesProxy : public vtkSMProxy
{
public:
static vtkSMGlobalPropertiesProxy* New();
vtkTypeMacro(vtkSMGlobalPropertiesProxy, vtkSMProxy);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Set up a property link with the given property on the proxy with the
* specified property on this proxy. The link is automatically broken if the
* target property is modified outside by someone other than this
* vtkSMGlobalPropertiesProxy instance or when the targetProxy is destroyed.
*/
bool Link(const char* propertyname, vtkSMProxy* targetProxy, const char* targetPropertyName);
/**
* Unlink a property link,
*/
bool Unlink(const char* propertyname, vtkSMProxy* targetProxy, const char* targetPropertyName);
/**
* Remove all links.
*/
void RemoveAllLinks();
/**
* If a link between the target and a property on this proxy exists, returns
* the name of that property else NULL.
*/
const char* GetLinkedPropertyName(vtkSMProxy* targetProxy, const char* targetPropertyName);
//@{
/**
* Overridden to save link state.
*/
virtual vtkPVXMLElement* SaveXMLState(
vtkPVXMLElement* root, vtkSMPropertyIterator* iter) VTK_OVERRIDE;
using Superclass::SaveXMLState;
//@}
/**
* Overridden to load links state.
*/
virtual int LoadXMLState(vtkPVXMLElement* element, vtkSMProxyLocator* locator) VTK_OVERRIDE;
protected:
vtkSMGlobalPropertiesProxy();
~vtkSMGlobalPropertiesProxy();
/**
* Overridden to propagate the modification to the linked properties.
*/
virtual void SetPropertyModifiedFlag(const char* name, int flag) VTK_OVERRIDE;
/**
* Called when a target properties is modified.
*/
void TargetPropertyModified(vtkObject*, unsigned long, void*);
private:
vtkSMGlobalPropertiesProxy(const vtkSMGlobalPropertiesProxy&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMGlobalPropertiesProxy&) VTK_DELETE_FUNCTION;
class vtkInternals;
vtkInternals* Internals;
};
#endif
|
