paraview.simple.BooleanKeyFrame

paraview.simple.BooleanKeyFrame(*input, **params)

one or more server manager objects. It also provides an interface to set and get the properties of the server side objects. These properties are presented as Python properties. For example, you can set a property Foo using the following:

proxy.Foo = (1,2)

or:

proxy.Foo.SetData((1,2))

or:

proxy.Foo[0:2] = (1,2)

For more information, see the documentation of the property which you can obtain with:

help(proxy.Foo).

This class also provides an iterator which can be used to iterate over all properties, e.g.:

proxy = Proxy(proxy=smproxy)
for property in proxy:
    print (property)

For advanced users: This is a python class that wraps a vtkSMProxy. Makes it easier to set/get properties. Instead of:

proxy.GetProperty("Foo").SetElement(0, 1)
proxy.GetProperty("Foo").SetElement(0, 2)

you can do:

proxy.Foo = (1,2)

or:

proxy.Foo.SetData((1,2))

or:

proxy.Foo[0:2] = (1,2)

Instead of:

proxy.GetProperty("Foo").GetElement(0)

you can do:

proxy.Foo.GetData()[0]

or:

proxy.Foo[0]

For proxy properties, you can use append:

proxy.GetProperty("Bar").AddProxy(foo)

you can do:

proxy.Bar.append(foo)

Properties support most of the list API. See VectorProperty and ProxyProperty documentation for details.

Please note that some of the methods accessible through the Proxy class are not listed by help() because the Proxy objects forward unresolved attributes to the underlying object. To get the full list, see also dir(proxy.SMProxy). See also the doxygen based documentation of the vtkSMProxy C++ class.

Data Descriptors

KeyTime

KeyValues

Data Descriptors inherited from Proxy

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

Methods

Initialize = aInitialize(self, connection=None, update=True)

Methods inherited from Proxy

GetProperty(self, name)

Given a property name, returns the property object.

GetPropertyValue(self, name)

Returns a scalar for properties with 1 elements, the property itself for vectors.

InitializeFromProxy(self, aProxy, update=True)

Constructor. Assigns proxy to self.SMProxy, updates the server object as well as register the proxy in _pyproxies dictionary.

ListProperties(self)

Returns a list of all property names on this proxy.

SetPropertyWithName(self, pname, arg)

Generic method for setting the value of a property.

__del__(self)

Destructor. Cleans up all observers as well as remove the proxy from the _pyproxies dictionary

__eq__(self, other)

Returns true if the underlying SMProxies are the same.

__getattr__(self, name)

With the exception of a few overloaded methods, returns the SMProxy method

__hash__(self)

Return hash(self).

__init__(self, **args)

Default constructor. It can be used to initialize properties by passing keyword arguments where the key is the name of the property. In addition registrationGroup and registrationName (optional) can be specified (as keyword arguments) to automatically register the proxy with the proxy manager.

__iter__(self)

Creates an iterator for the properties.

__ne__(self, other)

Returns false if the underlying SMProxies are the same.

__setattr__(self, name, value)

Implement setattr(self, name, value).

add_attribute(self, name, value)

For the full list of servermanager proxies, please refer to Available readers, sources, writers, filters and animation cues