simple.animation Module¶

paraview.simple.animation.AnimateReader(reader=None, view=None)[source]¶

This is a utility function that, given a reader and a view animates over all time steps of the reader.

Parameters

reader (reader proxy) – The reader source to iterate over. Optional, defaults to the active source.
view (view proxy) – The view to animate. Optional, defaults to the active view.

Returns

A new animation scene used to play the animation.

Return type

paraview.simple.AnimationSceneProxy

paraview.simple.animation.GetAnimationScene()[source]¶

Returns the application-wide animation scene. ParaView has only one global animation scene. This method provides access to that. You are free to create additional animation scenes directly, but those scenes won’t be shown in the ParaView GUI.

Returns: The animation scene
Return type: paraview.servermanager.AnimationScene

paraview.simple.animation.GetAnimationTrack(propertyname_or_property, index=None, proxy=None)[source]¶

Returns an animation cue for the property. If one doesn’t exist then a new one will be created. Typical usage:

track = GetAnimationTrack("Center", 0, sphere) or
track = GetAnimationTrack(sphere.GetProperty("Radius")) or

# this returns the track to animate visibility of the active source in
# all views.
track = GetAnimationTrack("Visibility")

For animating properties on implicit planes etc., use the following signatures:

track = GetAnimationTrack(slice.SliceType.GetProperty("Origin"), 0) or
track = GetAnimationTrack("Origin", 0, slice.SliceType)

paraview.simple.animation.GetCameraTrack(view=None)[source]¶

Returns the camera animation track for the given view.

Parameters: view (View proxy) – The view whose camera animation track should be retrieved. If no view is specified, the active view will be used. If no existing camera animation track is found, a new one will be created.
Returns: Camera animation cue
Return type: paraview.servermanager.CameraAnimationCue

paraview.simple.animation.GetRepresentationAnimationHelper(sourceproxy)[source]¶: Method that returns the representation animation helper for a source proxy. It creates a new one if none exists.

paraview.simple.animation.GetTimeKeeper()[source]¶

Returns the timekeeper proxy for the active session. Timekeeper is often used to manage time step information known to the ParaView application.

Returns: timekeeper
Return type: paraview.servermanager.TimeKeeper

paraview.simple.animation.GetTimeTrack()[source]¶

Returns the animation track used to control the time requested from all sources during playback

Returns: The time animation track.
Return type: paraview.servermanager.TimeAnimationCue