csc.layers.CyclesViewer

class csc.layers.CyclesViewer

Cycle viewer class. Provides methods for viewing and interacting with cycles within a layer.

__init__(self: csc.layers.CyclesViewer, layer: csc.layers.Layer) → None

Methods

__init__(self, layer)
any_cycles_exist_in_frames(self, arg0, arg1)	Checks if any cycles exist within the specified frames.
cycle_contains_frame_index(self, arg0, arg1)	Checks if the cycle contains the specified frame index.
find_cycle(self, arg0)	Finds a cycle by the specified position.
get_active_pos(self, arg0)	Retrieves the active position of the cycle.
get_active_section_pos(self, arg0)	Retrieves the active section position of the cycle.
get_cycles_in_frames(self, arg0, arg1)	Retrieves the cycles within the specified frames.
get_most_left_and_right_frame_indices_of_cycle(...)	Retrieves the most left and right frame indices of the cycle.
is_pos_in_active_cycle_zone(self, arg0)	Checks if the specified position is within the active cycle zone.
is_pos_in_inactive_cycle_zone(self, arg0)	Checks if the specified position is within the inactive cycle zone.
last_pos(self)

__annotations__ = {}

__init__(self: csc.layers.CyclesViewer, layer: csc.layers.Layer) → None

__module__ = 'csc.layers'

any_cycles_exist_in_frames(self: csc.layers.CyclesViewer, arg0: int, arg1: int) → bool

Checks if any cycles exist within the specified frames.

Parameters:

• first_frame_index (int) – The index of the first frame.

• last_frame_index (int) – The index of the last frame.

Returns:

True if any cycles exist within the frames, False otherwise.

Return type:

bool

cycle_contains_frame_index(self: csc.layers.CyclesViewer, arg0: csc.layers.Cycle, arg1: int) → bool

Checks if the cycle contains the specified frame index.

Parameters:

frame_index (int) – The frame index to check.

Returns:

True if the cycle contains the frame index, False otherwise.

Return type:

bool

find_cycle(self: csc.layers.CyclesViewer, arg0: int) → object

Finds a cycle by the specified position.

Parameters:

pos (int) – The position to search for.

Returns:

The found cycle.

Return type:

csc.layers.Cycle

get_active_pos(self: csc.layers.CyclesViewer, arg0: int) → int

Retrieves the active position of the cycle.

Returns:

The active position of the cycle.

Return type:

int

get_active_section_pos(self: csc.layers.CyclesViewer, arg0: int) → int

Retrieves the active section position of the cycle.

Returns:

The active section position of the cycle.

Return type:

int

get_cycles_in_frames(self: csc.layers.CyclesViewer, arg0: int, arg1: int) → list[csc.layers.Cycle]

Retrieves the cycles within the specified frames.

Parameters:

• first_frame_index (int) – The index of the first frame.

• last_frame_index (int) – The index of the last frame.

Returns:

The cycles within the frames.

Return type:

List[csc.layers.Cycle]

get_most_left_and_right_frame_indices_of_cycle(self: csc.layers.CyclesViewer, arg0: csc.layers.Cycle) → tuple[int, int]

Retrieves the most left and right frame indices of the cycle.

Returns:

The most left and right frame indices of the cycle.

Return type:

Tuple[int, int]

is_pos_in_active_cycle_zone(self: csc.layers.CyclesViewer, arg0: int) → bool

Checks if the specified position is within the active cycle zone.

Parameters:

pos (int) – The position to check.

Returns:

True if the position is within the active cycle zone, False otherwise.

Return type:

bool

is_pos_in_inactive_cycle_zone(self: csc.layers.CyclesViewer, arg0: int) → bool

Checks if the specified position is within the inactive cycle zone.

Parameters:

pos (int) – The position to check.

Returns:

True if the position is within the inactive cycle zone, False otherwise.

Return type:

bool

last_pos(self: csc.layers.CyclesViewer) → int