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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*=========================================================================
Program: ParaView
Module: vtkSMProxyLink.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 vtkSMProxyLink
* @brief creates a link between two proxies.
*
* When a link is created between proxy A->B, whenever any property
* on proxy A is modified, a property with the same name as the modified
* property (if any) on proxy B is also modified to be the same as the property
* on the proxy A. Similary whenever proxy A->UpdateVTKObjects() is called,
* B->UpdateVTKObjects() is also fired.
*/
#ifndef vtkSMProxyLink_h
#define vtkSMProxyLink_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMLink.h"
struct vtkSMProxyLinkInternals;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMProxyLink : public vtkSMLink
{
public:
static vtkSMProxyLink* New();
vtkTypeMacro(vtkSMProxyLink, vtkSMLink);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
/**
* Add a property to the link. updateDir determines whether a property of
* the proxy is read or written. When a property of an input proxy
* changes, it's value is pushed to all other output proxies in the link.
* A proxy can be set to be both input and output by adding 2 link, one
* to INPUT and the other to OUTPUT
*/
virtual void AddLinkedProxy(vtkSMProxy* proxy, int updateDir);
/**
* Remove a linked proxy.
*/
virtual void RemoveLinkedProxy(vtkSMProxy* proxy);
//@{
/**
* Get the number of proxies that are involved in this link.
*/
unsigned int GetNumberOfLinkedObjects() VTK_OVERRIDE;
unsigned int GetNumberOfLinkedProxies();
//@}
/**
* Get a proxy involved in this link.
*/
vtkSMProxy* GetLinkedProxy(int index) VTK_OVERRIDE;
//@{
/**
* Get the direction of a proxy involved in this link
* (see vtkSMLink::UpdateDirections)
*/
int GetLinkedObjectDirection(int index) VTK_OVERRIDE;
int GetLinkedProxyDirection(int index);
//@}
//@{
/**
* It is possible to exclude certain properties from being synchronized
* by this link. This method can be used to add/remove the names for such
* exception properties.
*/
void AddException(const char* propertyname);
void RemoveException(const char* propertyname);
//@}
/**
* Remove all links.
*/
virtual void RemoveAllLinks() VTK_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. 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.
*/
virtual void LoadState(const vtkSMMessage* msg, vtkSMProxyLocator* locator) VTK_OVERRIDE;
protected:
vtkSMProxyLink();
~vtkSMProxyLink();
/**
* Called when an input proxy is updated (UpdateVTKObjects).
* Argument is the input proxy.
*/
virtual void UpdateVTKObjects(vtkSMProxy* proxy) VTK_OVERRIDE;
/**
* Called when a property of an input proxy is modified.
* caller:- the input proxy.
* pname:- name of the property being modified.
*/
virtual void PropertyModified(vtkSMProxy* proxy, const char* pname) VTK_OVERRIDE;
/**
* Called when a property is pushed.
* caller :- the input proxy.
* pname :- name of property that was pushed.
*/
virtual void UpdateProperty(vtkSMProxy* caller, const char* pname) VTK_OVERRIDE;
/**
* Save the state of the link.
*/
virtual void SaveXMLState(const char* linkname, vtkPVXMLElement* parent) VTK_OVERRIDE;
/**
* Load the link state.
*/
virtual int LoadXMLState(vtkPVXMLElement* linkElement, vtkSMProxyLocator* locator) VTK_OVERRIDE;
/**
* Update the internal protobuf state
*/
virtual void UpdateState() VTK_OVERRIDE;
private:
vtkSMProxyLinkInternals* Internals;
vtkSMProxyLink(const vtkSMProxyLink&) VTK_DELETE_FUNCTION;
void operator=(const vtkSMProxyLink&) VTK_DELETE_FUNCTION;
};
#endif
|
