used to build a vtkSMCompoundSourceProxy definition.
More...
#include <vtkSMCompoundSourceProxyDefinitionBuilder.h>
used to build a vtkSMCompoundSourceProxy definition.
vtkSMCompoundSourceProxyDefinitionBuilder is used to create a XML definition for a compound-proxy consisting of other proxies. This class can only build one compound-proxy definition at a time. Use Reset() to start a new definition.
- See also
- vtkSMCompoundSourceProxy
Definition at line 37 of file vtkSMCompoundSourceProxyDefinitionBuilder.h.
◆ Superclass
◆ vtkSMCompoundSourceProxyDefinitionBuilder()
vtkSMCompoundSourceProxyDefinitionBuilder::vtkSMCompoundSourceProxyDefinitionBuilder |
( |
| ) |
|
|
protected |
◆ ~vtkSMCompoundSourceProxyDefinitionBuilder()
vtkSMCompoundSourceProxyDefinitionBuilder::~vtkSMCompoundSourceProxyDefinitionBuilder |
( |
| ) |
|
|
protected |
◆ New()
◆ GetClassName()
virtual const char* vtkSMCompoundSourceProxyDefinitionBuilder::GetClassName |
( |
| ) |
|
|
virtual |
◆ IsTypeOf()
static int vtkSMCompoundSourceProxyDefinitionBuilder::IsTypeOf |
( |
const char * |
type | ) |
|
|
static |
◆ IsA()
virtual int vtkSMCompoundSourceProxyDefinitionBuilder::IsA |
( |
const char * |
type | ) |
|
|
virtual |
◆ SafeDownCast()
◆ PrintSelf()
void vtkSMCompoundSourceProxyDefinitionBuilder::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
| |
◆ Reset()
void vtkSMCompoundSourceProxyDefinitionBuilder::Reset |
( |
| ) |
|
Resets the builder.
This can be used when using the builder to create multiple definitions.
◆ AddProxy()
void vtkSMCompoundSourceProxyDefinitionBuilder::AddProxy |
( |
const char * |
name, |
|
|
vtkSMProxy * |
proxy |
|
) |
| |
Add a proxy to be included in this compound proxy.
The name must be unique to each proxy added, otherwise the previously added proxy will be replaced.
◆ ExposeProperty()
void vtkSMCompoundSourceProxyDefinitionBuilder::ExposeProperty |
( |
const char * |
proxyName, |
|
|
const char * |
propertyName, |
|
|
const char * |
exposedName |
|
) |
| |
Expose a property from the sub proxy (added using AddProxy).
Only exposed properties are accessible externally. Note that the sub proxy whose property is being exposed must have been already added using AddProxy().
◆ ExposeOutputPort() [1/2]
void vtkSMCompoundSourceProxyDefinitionBuilder::ExposeOutputPort |
( |
const char * |
proxyName, |
|
|
const char * |
portName, |
|
|
const char * |
exposedName |
|
) |
| |
Expose an output port from a subproxy.
Exposed output ports are treated as output ports of the vtkSMCompoundSourceProxy itself. This method does not may the output port available. One must call CreateOutputPorts().
◆ ExposeOutputPort() [2/2]
void vtkSMCompoundSourceProxyDefinitionBuilder::ExposeOutputPort |
( |
const char * |
proxyName, |
|
|
unsigned int |
portIndex, |
|
|
const char * |
exposedName |
|
) |
| |
Expose an output port from a subproxy.
Exposed output ports are treated as output ports of the vtkSMCompoundSourceProxy itself. This method does not may the output port available. One must call CreateOutputPorts().
◆ GetNumberOfProxies()
unsigned int vtkSMCompoundSourceProxyDefinitionBuilder::GetNumberOfProxies |
( |
| ) |
|
Returns the number of sub-proxies.
◆ GetProxy() [1/2]
vtkSMProxy* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxy |
( |
unsigned int |
cc | ) |
|
Returns the sub proxy at a given index.
◆ GetProxy() [2/2]
vtkSMProxy* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxy |
( |
const char * |
name | ) |
|
Returns the subproxy with the given name.
◆ GetProxyName()
const char* vtkSMCompoundSourceProxyDefinitionBuilder::GetProxyName |
( |
unsigned int |
index | ) |
|
Returns the name used to store sub-proxy.
Returns 0 if sub-proxy does not exist.
◆ SaveDefinition()
This is the same as save state except it will remove all references to "outside" proxies.
Outside proxies are proxies that are not contained in the compound proxy. As a result, the saved state will be self contained. Returns the top element created. It is the caller's responsibility to delete the returned element. If root is NULL, the returned element will be a top level element.
The documentation for this class was generated from the following file: