#include <vtkSMPropertyLink.h>
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| unsigned int | GetNumberOfLinkedProperties () |
| vtkSMProperty * | GetLinkedProperty (int index) |
| vtkSMProxy * | GetLinkedProxy (int index) |
| const char * | GetLinkedPropertyName (int index) |
| int | GetLinkedPropertyDirection (int index) |
| virtual void | RemoveAllLinks () |
| virtual void | LoadState (const vtkSMMessage *msg, vtkSMProxyLocator *locator) |
| void | AddLinkedProperty (vtkSMProxy *proxy, const char *propertyname, int updateDir) |
| void | RemoveLinkedProperty (vtkSMProxy *proxy, const char *propertyname) |
Static Public Member Functions | |
| static vtkSMPropertyLink * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkSMPropertyLink * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkSMPropertyLink () | |
| ~vtkSMPropertyLink () | |
| void | Synchronize () |
| virtual int | LoadXMLState (vtkPVXMLElement *linkElement, vtkSMProxyLocator *locator) |
| virtual void | SaveXMLState (const char *linkname, vtkPVXMLElement *parent) |
| virtual void | UpdateVTKObjects (vtkSMProxy *caller) |
| virtual void | PropertyModified (vtkSMProxy *caller, const char *pname) |
| virtual void | UpdateProperty (vtkSMProxy *caller, const char *pname) |
| void | PropertyModified (vtkSMProperty *property) |
Friends | |
| struct | vtkSMPropertyLinkInternals |
| class | vtkSMPropertyLinkObserver |
| virtual void | UpdateState () |
Detailed Description
Creates a link between two properties. Can create M->N links. At the time when the link is created every output property is synchornized with the first input property.
Definition at line 33 of file vtkSMPropertyLink.h.
Constructor & Destructor Documentation
| vtkSMPropertyLink::vtkSMPropertyLink | ( | ) | [protected] |
| vtkSMPropertyLink::~vtkSMPropertyLink | ( | ) | [protected] |
Member Function Documentation
| static vtkSMPropertyLink* vtkSMPropertyLink::New | ( | ) | [static] |
Reimplemented from vtkSMSessionObject.
| virtual const char* vtkSMPropertyLink::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkSMLink.
| static vtkSMPropertyLink* vtkSMPropertyLink::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkSMLink.
| void vtkSMPropertyLink::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Reimplemented from vtkSMLink.
| void vtkSMPropertyLink::AddLinkedProperty | ( | vtkSMProxy * | proxy, |
| const char * | propertyname, | ||
| int | updateDir | ||
| ) |
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 propterty can be set to be both input and output by adding 2 link, one to INPUT and the other to OUTPUT When a link is added, all output property values are synchronized with that of the input.
| void vtkSMPropertyLink::RemoveLinkedProperty | ( | vtkSMProxy * | proxy, |
| const char * | propertyname | ||
| ) |
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 propterty can be set to be both input and output by adding 2 link, one to INPUT and the other to OUTPUT When a link is added, all output property values are synchronized with that of the input.
| unsigned int vtkSMPropertyLink::GetNumberOfLinkedProperties | ( | ) |
Another API to add a property link. In this case. we don't provide the link with the proxy to which the property belongs. Consequently we cannot propagate UpdateVTKObjects() calls irrespective of the PropagateUpdateVTKObjects flag. If one wants to propagate UpdateVTKObjects, use the overload with vtkSMProxy as the argument. When a link is added, all output property values are synchronized with that of the input. DEPRECATED void AddLinkedProperty(vtkSMProperty* property, int updateDir);
Remove a linked property. DEPRECATED void RemoveLinkedProperty(vtkSMProperty* property);
Get the number of properties that are involved in this link.
| vtkSMProperty* vtkSMPropertyLink::GetLinkedProperty | ( | int | index | ) |
Get a property involved in this link.
| vtkSMProxy* vtkSMPropertyLink::GetLinkedProxy | ( | int | index | ) |
Get a proxy involved in this link.
| const char* vtkSMPropertyLink::GetLinkedPropertyName | ( | int | index | ) |
Get a property involved in this link.
Get the direction of a property involved in this link (see vtkSMLink::UpdateDirections)
| virtual void vtkSMPropertyLink::RemoveAllLinks | ( | ) | [virtual] |
Remove all links.
Implements vtkSMLink.
| virtual void vtkSMPropertyLink::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.
| void vtkSMPropertyLink::Synchronize | ( | ) | [protected] |
Synchornize the value of all output properties with the input property.
| virtual int vtkSMPropertyLink::LoadXMLState | ( | vtkPVXMLElement * | linkElement, |
| vtkSMProxyLocator * | locator | ||
| ) | [protected, virtual] |
Load the link state.
Implements vtkSMLink.
| virtual void vtkSMPropertyLink::SaveXMLState | ( | const char * | linkname, |
| vtkPVXMLElement * | parent | ||
| ) | [protected, virtual] |
Save the state of the link.
Implements vtkSMLink.
| virtual void vtkSMPropertyLink::UpdateVTKObjects | ( | vtkSMProxy * | proxy | ) | [protected, virtual] |
Called when an input proxy is updated (UpdateVTKObjects). Argument is the input proxy.
Implements vtkSMLink.
| virtual void vtkSMPropertyLink::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.
| virtual void vtkSMPropertyLink::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.
| void vtkSMPropertyLink::PropertyModified | ( | vtkSMProperty * | property | ) | [protected] |
| virtual void vtkSMPropertyLink::UpdateState | ( | ) | [protected, virtual] |
Update the internal protobuf state
Friends And Related Function Documentation
friend struct vtkSMPropertyLinkInternals [friend] |
Definition at line 102 of file vtkSMPropertyLink.h.
friend class vtkSMPropertyLinkObserver [friend] |
Definition at line 103 of file vtkSMPropertyLink.h.
The documentation for this class was generated from the following file:
- dox/ParaViewCore/ServerManager/vtkSMPropertyLink.h
