Handling Blender Frames

class bsr.frame.FrameManager(*args, **kwargs)[source]

This class provides methods for manipulating the frame of the scene. Only one instance exist, which you can access by: bsr.frame_manager.

update(frame_forward=1)[source]

Update the current frame number of the scene.

Return type:

None

Parameters:
frame_forwardint, optional

The number of frames to move forward. The default is 1.

property frame_current: int

Return the current frame number of the scene.

property frame_start: int

Return the start frame number of the scene.

Returns:
int

The start frame number of the scene.

property frame_end: int

Return the end frame number of the scene.

Returns:
int

The end frame number of the scene.

property frame_rate: float

Return the frame rate of the scene.

Returns:
float

The frame rate of the scene. (Frame per second)

enumerate(iterable, frame_current_init=None)[source]

Enumerate through the frames of the scene.

Return type:

Iterable

Parameters:
iterableIterable

An iterable object to enumerate.

frame_current_initint, optional

The initial current frame number of the scene. The default is None. If None, the number self.frame_current is used.