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
148
|
/*=========================================================================
Program: ParaView
Module: vtkSMProxyListDomain.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.
=========================================================================*/
// .NAME vtkSMProxyListDomain - union of proxies.
// .SECTION Description
// This domain is a collection of proxies that can be assigned as the value
// to a vtkSMProxyProperty.
// The Server Mananger configuration defines the proxy types that form this list,
// while the value of this domain is the list of instances of proxies.
// Example usage :
// <ProxyListDomain name="proxy_list">
// <Proxy group="implicit_functions"
// name="Plane" />
// <Group name="implicit_functions"/>
// </ProxyListDomain>
//
// .SECTION See Also
// vtkSMDomain vtkSMProxyProperty
#ifndef vtkSMProxyListDomain_h
#define vtkSMProxyListDomain_h
#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMDomain.h"
class vtkSMProperty;
class vtkSMProxy;
class vtkSMProxyListDomainInternals;
class vtkSMSessionProxyManager;
class VTKPVSERVERMANAGERCORE_EXPORT vtkSMProxyListDomain : public vtkSMDomain
{
public:
static vtkSMProxyListDomain* New();
vtkTypeMacro(vtkSMProxyListDomain, vtkSMDomain);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Returns the number of proxies in the domain.
unsigned int GetNumberOfProxyTypes();
// Description:
// Returns the xml group name for the proxy at a given index.
const char* GetProxyGroup(unsigned int index);
// Description:
// Returns the xml type name for the proxy at a given index.
const char* GetProxyName(unsigned int index);
// Description:
// If the \c proxy is part of the domain, then this returns the name used for
// the proxy in the domain. Returns NULL otherwise.
const char* GetProxyName(vtkSMProxy* proxy);
// Description:
// This always returns true.
virtual int IsInDomain(vtkSMProperty* property);
// Description:
// Add a proxy to the domain.
void AddProxy(vtkSMProxy*);
// Description:
// Returns if the proxy is present in the domain.
bool HasProxy(vtkSMProxy*);
// Description:
// Get number of proxies in the domain.
unsigned int GetNumberOfProxies();
// Description:
// Get proxy at a given index.
vtkSMProxy* GetProxy(unsigned int index);
// Description:
// Find a proxy in the domain of the given group and type.
vtkSMProxy* FindProxy(const char* xmlgroup, const char* xmlname);
// Description:
// Removes the first occurence of the \c proxy in the domain.
// Returns if the proxy was removed.
int RemoveProxy(vtkSMProxy* proxy);
// Description:
// Removes the proxy at the given index.
// Returns if the proxy was removed.
int RemoveProxy(unsigned int index);
// Description:
// Creates and populates the domain with the proxy-types. This will remove any
// existing proxies in the domain. Note that the newly created proxies won't
// be registered with the proxy manager.
void CreateProxies(vtkSMSessionProxyManager* pxm);
// Description:
// A vtkSMProperty is often defined with a default value in the
// XML itself. However, many times, the default value must be determined
// at run time. To facilitate this, domains can override this method
// to compute and set the default value for the property.
// Note that unlike the compile-time default values, the
// application must explicitly call this method to initialize the
// property.
virtual int SetDefaultValues(vtkSMProperty* prop, bool use_unchecked_values);
protected:
vtkSMProxyListDomain();
~vtkSMProxyListDomain();
// Description:
// Set the appropriate ivars from the xml element. Should
// be overwritten by subclass if adding ivars.
int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* element);
// Description:
// Adds a proxy type, used by ReadXMLAttributes().
void AddProxy(const char* group, const char* name);
// Description:
// Save state for this domain.
virtual void ChildSaveState(vtkPVXMLElement* propertyElement);
// Load the state of the domain from the XML.
virtual int LoadState(vtkPVXMLElement* domainElement,
vtkSMProxyLocator* loader);
friend class vtkSMProxyProperty;
void SetProxies(vtkSMProxy** proxies, unsigned int count);
private:
vtkSMProxyListDomain(const vtkSMProxyListDomain&); // Not implemented.
void operator=(const vtkSMProxyListDomain&); // Not implemented.
vtkSMProxyListDomainInternals* Internals;
};
#endif
|
