simple.link Module¶
- paraview.simple.link.AddCameraLink(viewProxy, viewProxyOther, linkName='')[source]¶
Create a named camera link between two view proxies. If a link with the given name already exists it will be removed first and replaced with the newly created link.
- Parameters:
viewProxy (View proxy.) – The first view to link.
viewProxyOther (View proxy.) – The second view to link.
linkName (str) – The name of the link to create. Optional, defaults to automatically generating a link name.
- Returns:
The link registration name.
- Return type:
str
- paraview.simple.link.AddProxyLink(proxy1, proxy2, linkName='', link=None)[source]¶
Create a link between two proxies and return its name.
An instance of a vtkSMProxyLink subclass can be given, otherwise a vtkSMProxyLink is created. This does not link proxy properties. See vtkSMProxyLink.LinkProxyPropertyProxies.
- Parameters:
linkName (str) – Name of link to create. If empty, a default one is created for registration. If a link with the given name already exists it will be removed first.
- Returns:
The link registration name.
- Return type:
str
- paraview.simple.link.AddRenderViewLink(viewProxy, viewProxyOther, linkName='', linkCameras=False)[source]¶
Create a named view link between two render view proxies.
It also creates links for the AxesGrid proxy property in each view. By default, cameras are not linked.
If a link with the given name already exists it will be removed first and replaced with the newly created link.
- Parameters:
viewProxy (View proxy.) – The first view to link.
viewProxyOther (View proxy.) – The second view to link.
linkName (str) – The name of the link to create.
linkCameras – If True, also link the view cameras.
- Returns:
The link registration name.
- Return type:
str
- paraview.simple.link.AddSelectionLink(objProxy, objProxyOther, linkName, convertToIndices=True)[source]¶
Create a named selection link between two source proxies. If a link with the given name already exists it will be removed first and repaced with the newly created link.
- Parameters:
objProxy (Source proxy) – First proxy to link.
objProxyOther (Source proxy) – Second proxy to link. If None, uses the active source.
linkName (str) – Name of the created link.
convertToIndices (bool) – When True (default value), the input selection will always be converted into an indices-based selection before being applied to outputs.
- paraview.simple.link.AddViewLink(viewProxy, viewProxyOther, linkName='')[source]¶
Create a view link between two view proxies.
A view link is an extension of a proxy link that also performs rendering when a property changes.
Cameras in the views are not linked.
If a link with the given name already exists it will be removed first and replaced with the newly created link.
- Parameters:
viewProxy (View proxy.) – The first view to link.
viewProxyOther (View proxy.) – The second view to link.
linkName (str) – The name of the link to create. Optional, defaults to automatically generating a link name.
- Returns:
The link registration name.
- Return type:
str
- paraview.simple.link.RemoveCameraLink(linkName)[source]¶
Remove a camera link with the given name.
- Parameters:
linkName (str) – Name of the link to remove.