util.proxy Module

paraview.util.proxy.get_consumers(proxy, filter, consumer_set, recursive=True)

Returns the consumers for a proxy iteratively. If filter is non-None, filter is used to cull consumers.

paraview.util.proxy.get_producers(proxy, filter, producer_set)

Returns the producers for a proxy iteratively. If filter is non-None, filter is used to cull producers.

paraview.util.proxy.rename(proxy, group=None, name=None)

Renames the given proxy. This is the name used by FindSource() and is displayed in the Pipeline Browser.

Parameters:

• proxy (Proxy object) – The proxy to be renamed

• group (str) – The group in which the proxy lives. Can be retrieved with proxy.GetXMLGroup() but not always (layouts vs misc).

• newName (str) – The new name of the proxy.

paraview.util.proxy.set(proxy, **props)

Sets one or more properties of the given proxy. Pass in arguments of the form property_name=value to this function to set property values.

For example:

set(
    proxy, # CAN NOT be None
    Center=[1, 2, 3],
    Radius=3.5,
)

Parameters:

• proxy (Source proxy) – The pipeline source whose properties should be set.

• params – A variadic list of key=value pairs giving values of specific named properties in the pipeline source. For a list of available properties, call help(proxy).

class paraview.util.proxy.supported_proxies

Bases: object

Filter object used to hide proxies that are currently not supported by the state saving mechanism or those that are generally skipped in state. There is none currently but keeping the method for backward compatibility and future proofing.

paraview.util.proxy.toposort(input_set)

implementation of Tarjan topological sort to sort proxies using consumer dependencies as graph edges.

paraview.util.proxy.unregister(proxy)

Unregister proxy from ParaView Pipeline Controller