FrameSequence#

class ansys.tools.visualization_interface.backends.pyvista.animation.FrameSequence#

Bases: abc.ABC

Abstract interface for frame data sources.

This class provides an abstraction for different frame storage strategies, allowing for in-memory, lazy-loaded, or computed frame sequences.

Overview#

get_frame

Retrieve frame at given index.

__len__

Return total number of frames.

Import detail#

from ansys.tools.visualization_interface.backends.pyvista.animation import FrameSequence

Method detail#

abstractmethod FrameSequence.get_frame(index: int) Any#

Retrieve frame at given index.

Parameters:
indexint

Frame index to retrieve.

Returns:
Any

Frame data (typically a PyVista mesh or MeshObjectPlot).

abstractmethod FrameSequence.__len__() int#

Return total number of frames.

Returns:
int

Total frame count.