simple.rendering Module¶
- paraview.simple.rendering.ColorBlocksBy(rep=None, selectors=None, value=None, separate=False)[source]¶
Like
ColorBy(), set data array by which to color selected blocks within a representation, but color only selected blocks with the specified properties. This will automatically set up the color maps and others necessary state for the representations.- Parameters
rep (Representation proxy) – Must be a representation proxy i.e. the value returned by the
GetRepresentation(). Optional, defaults to the display properties for the active source, if possible.selectors (list of str) – List of block selectors that choose which blocks to modify with this call.
value (str) – Name of the array to color by.
separate (bool) – Set to True to create a color map unique to this representation. Optional, default is that the color map used will be the global color map ParaView uses for any object colored by an array of the same name.
- paraview.simple.rendering.ColorBy(rep=None, value=None, separate=False)[source]¶
Set data array to color a representation by. This will automatically set up the color maps and others necessary state for the representations.
- Parameters
rep (Representation proxy) – Must be a representation proxy i.e. the value returned by the
GetRepresentation(). Optional, defaults to the display properties for the active source, if possible.value (str) – Name of the array to color by.
separate (bool) – Set to True to create a color map unique to this representation. Optional, defaults to the global color map ParaView uses for any object colored by an array of the same name.
- paraview.simple.rendering.GetDisplayProperties(proxy=None, view=None)[source]¶
DEPRECATED: Should use GetRepresentation() instead.
- paraview.simple.rendering.GetRepresentation(proxy=None, view=None)[source]¶
Given a pipeline proxy and a view, returns the corresponding representation object. If proxy and view are not specified, active objects are used.
- Parameters
proxy (Source proxy) – Pipeline proxy whose representation in the given view is requested. Optional, defaults to the active view.
view (View proxy) – The view associated with the requested representation. Optional, defaults to returning the representation associated with the active view.
- Returns
The representation for the given proxy in the view.
- Return type
Representation proxy
- paraview.simple.rendering.Hide(proxy=None, view=None)[source]¶
Turns the visibility of a given pipeline source off in the given view. If pipeline object and/or view are not specified, active objects are used.
- Parameters
proxy (Pipeline source proxy to hide.) – The pipeline source. Optional, defaults to the active source.
view (View proxy.) – The view in which the pipeline source should be hidden. Optional, defaults to the active view.
- paraview.simple.rendering.HideAll(view=None)[source]¶
Hide all pipeline sources in the given view.
- Parameters
view (View proxy.) – The view in which to hide all pipeline sources. Optional, defaults to the active view.
- paraview.simple.rendering.Interact(view=None)[source]¶
Call this method to start interacting with a view. This method will block until the interaction is done. If the local process cannot support interactions, this method will simply return without doing anything.
- Parameters
view (View proxy.) – The interaction occurs with this view. Optional, defaults to the active view.
- paraview.simple.rendering.Render(view=None)[source]¶
Renders the given view if given, otherwise renders the active view. If this is the first render and the view is a RenderView, the camera is reset.
- Parameters
view (View proxy.) – The view to render. Optional, defaults to rendering the active view.
- paraview.simple.rendering.SetDisplayProperties(proxy=None, view=None, **params)[source]¶
DEPRECATED: Should use SetRepresentationProperties() instead
- paraview.simple.rendering.SetRepresentationProperties(proxy=None, view=None, **params)[source]¶
Sets one or more representation properties of the given pipeline source.
Pass a list of property_name=value pairs to this function to set property values. For example:
SetProperties(Color=[1, 0, 0], LineWidth=2)
- Parameters
proxy (Source proxy) – Pipeline source whose representation properties should be set. Optional, defaults to the active source.
view (View proxy) – The view in which to make the representation property changes. Optional, defaults to the active view.
- paraview.simple.rendering.Show(proxy=None, view=None, representationType=None, **params)[source]¶
Turns on the visibility of a given pipeline proxy in the given view. If pipeline proxy and/or view are not specified, active objects are used.
- Parameters
proxy (Source proxy.) – The pipeline proxy to show. If not provided, uses the active source.
view (View proxy.) – The view proxy to show the source proxy in. Optional, defaults to the active view.
representationType (str) – Name of the representation type to use. Optional, defaults to a suitable representation for the source proxy and view.
- Returns
The representation proxy for the source proxy in the view.
- Return type
Representation proxy.: