creates a link between two proxies. More...
#include <vtkSMProxyLink.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | AddLinkedProxy (vtkSMProxy *proxy, int updateDir) |
| virtual void | RemoveLinkedProxy (vtkSMProxy *proxy) |
| unsigned int | GetNumberOfLinkedProxies () |
| vtkSMProxy * | GetLinkedProxy (int index) |
| int | GetLinkedProxyDirection (int index) |
| virtual void | RemoveAllLinks () |
| virtual void | LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator) |
| void | AddException (const char *propertyname) |
| void | RemoveException (const char *propertyname) |
Static Public Member Functions | |
| static vtkSMProxyLink * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMProxyLink * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkSMProxyLink () | |
| ~vtkSMProxyLink () | |
| virtual void | UpdateVTKObjects (vtkSMProxy *proxy) |
| virtual void | PropertyModified (vtkSMProxy *proxy, const char *pname) |
| virtual void | UpdateProperty (vtkSMProxy *caller, const char *pname) |
| virtual void | SaveXMLState (const char *linkname, vtkPVXMLElement *parent) |
| virtual int | LoadXMLState (vtkPVXMLElement *linkElement, vtkSMProxyLocator *locator) |
| virtual void | UpdateState () |
Detailed Description
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.
Definition at line 34 of file vtkSMProxyLink.h.
Constructor & Destructor Documentation
| vtkSMProxyLink::vtkSMProxyLink | ( | ) | [protected] |
| vtkSMProxyLink::~vtkSMProxyLink | ( | ) | [protected] |
Member Function Documentation
| static vtkSMProxyLink* vtkSMProxyLink::New | ( | ) | [static] |
Reimplemented from vtkSMSessionObject.
Reimplemented in vtkSMCameraLink.
| virtual const char* vtkSMProxyLink::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMLink.
Reimplemented in vtkSMCameraLink.
| static int vtkSMProxyLink::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkSMLink.
Reimplemented in vtkSMCameraLink.
| virtual int vtkSMProxyLink::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkSMLink.
Reimplemented in vtkSMCameraLink.
| static vtkSMProxyLink* vtkSMProxyLink::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMLink.
Reimplemented in vtkSMCameraLink.
| void vtkSMProxyLink::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMLink.
Reimplemented in vtkSMCameraLink.
| virtual void vtkSMProxyLink::AddLinkedProxy | ( | vtkSMProxy * | proxy, |
| int | updateDir | ||
| ) | [virtual] |
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
Reimplemented in vtkSMCameraLink.
| virtual void vtkSMProxyLink::RemoveLinkedProxy | ( | vtkSMProxy * | proxy | ) | [virtual] |
Remove a linked proxy.
Reimplemented in vtkSMCameraLink.
| unsigned int vtkSMProxyLink::GetNumberOfLinkedProxies | ( | ) |
Get the number of proxies that are involved in this link.
| vtkSMProxy* vtkSMProxyLink::GetLinkedProxy | ( | int | index | ) |
Get a proxy involved in this link.
Get the direction of a proxy involved in this link (see vtkSMLink::UpdateDirections)
| void vtkSMProxyLink::AddException | ( | const char * | propertyname | ) |
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 vtkSMProxyLink::RemoveException | ( | const char * | propertyname | ) |
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.
| virtual void vtkSMProxyLink::RemoveAllLinks | ( | ) | [virtual] |
Remove all links.
Implements vtkSMLink.
| virtual void vtkSMProxyLink::LoadState | ( | const vtkSMMessage * | msg, |
| vtkSMProxyLocator * | locator | ||
| ) | [virtual] |
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.
Reimplemented from vtkSMLink.
Reimplemented in vtkSMCameraLink.
| virtual void vtkSMProxyLink::UpdateVTKObjects | ( | vtkSMProxy * | proxy | ) | [protected, virtual] |
Called when an input proxy is updated (UpdateVTKObjects). Argument is the input proxy.
Implements vtkSMLink.
Reimplemented in vtkSMCameraLink.
| virtual void vtkSMProxyLink::PropertyModified | ( | vtkSMProxy * | proxy, |
| const char * | pname | ||
| ) | [protected, virtual] |
Called when a property of an input proxy is modified. caller:- the input proxy. pname:- name of the property being modified.
Implements vtkSMLink.
Reimplemented in vtkSMCameraLink.
| virtual void vtkSMProxyLink::UpdateProperty | ( | vtkSMProxy * | caller, |
| const char * | pname | ||
| ) | [protected, virtual] |
Called when a property is pushed. caller :- the input proxy. pname :- name of property that was pushed.
Implements vtkSMLink.
Reimplemented in vtkSMCameraLink.
| virtual void vtkSMProxyLink::SaveXMLState | ( | const char * | linkname, |
| vtkPVXMLElement * | parent | ||
| ) | [protected, virtual] |
| virtual int vtkSMProxyLink::LoadXMLState | ( | vtkPVXMLElement * | linkElement, |
| vtkSMProxyLocator * | locator | ||
| ) | [protected, virtual] |
Load the link state.
Implements vtkSMLink.
| virtual void vtkSMProxyLink::UpdateState | ( | ) | [protected, virtual] |
Update the internal protobuf state
Reimplemented in vtkSMCameraLink.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMProxyLink.h
