Skip to content

scening

Classes:

SceningList 

SceningList(
    name: str = "",
    max_value: Frame | None = None,
    items: list[Scene] | None = None,
    *,
    temporary: bool = False
)

Bases: QAbstractTableModel, QYAMLObject

Methods:

Attributes:

Source code 
27
28
def __init__(self, name: str = '', max_value: Frame | None = None, items: list[Scene] | None = None, *, temporary: bool = False) -> None:
    self.setValue(name, max_value, items, temporary=temporary)

COLUMN_COUNT class-attribute instance-attribute 

COLUMN_COUNT = 5

END_FRAME_COLUMN class-attribute instance-attribute 

END_FRAME_COLUMN = 1

END_TIME_COLUMN class-attribute instance-attribute 

END_TIME_COLUMN = 3

LABEL_COLUMN class-attribute instance-attribute 

LABEL_COLUMN = 4

START_FRAME_COLUMN class-attribute instance-attribute 

START_FRAME_COLUMN = 0

START_TIME_COLUMN class-attribute instance-attribute 

START_TIME_COLUMN = 2

add 

add(start: Frame, end: Frame | None = None, label: str = '') -> Scene
Source code 
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
def add(self, start: Frame, end: Frame | None = None, label: str = '') -> Scene:
    scene = Scene(start, end, label)

    if scene in self.items:
        return scene

    if scene.end > self.max_value:
        raise ValueError('New Scene is out of bounds of output')

    index = bisect_right(self.items, scene)
    self.beginInsertRows(QModelIndex(), index, index)
    self.items.insert(index, scene)
    self.endInsertRows()

    return scene

columnCount 

columnCount(parent: QModelIndex = QModelIndex()) -> int
Source code 
42
43
def columnCount(self, parent: QModelIndex = QModelIndex()) -> int:
    return self.COLUMN_COUNT

data 

data(index: QModelIndex, role: int = UserRole) -> Any
Source code 
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def data(self, index: QModelIndex, role: int = Qt.ItemDataRole.UserRole) -> Any:
    if not index.isValid():
        return None
    row = index.row()
    if row >= len(self.items):
        return None
    column = index.column()
    if column >= self.COLUMN_COUNT:
        return None

    if role in {Qt.ItemDataRole.DisplayRole, Qt.ItemDataRole.EditRole}:
        if column == self.START_FRAME_COLUMN:
            return str(self.items[row].start)
        if column == self.END_FRAME_COLUMN:
            if self.items[row].end != self.items[row].start:
                return str(self.items[row].end)
            else:
                return ''
        if column == self.START_TIME_COLUMN:
            return str(Time(self.items[row].start))
        if column == self.END_TIME_COLUMN:
            if self.items[row].end != self.items[row].start:
                return str(Time(self.items[row].end))
            else:
                return ''
        if column == self.LABEL_COLUMN:
            return str(self.items[row].label)

    if role == Qt.ItemDataRole.UserRole:
        if column == self.START_FRAME_COLUMN:
            return self.items[row].start
        if column == self.END_FRAME_COLUMN:
            return self.items[row].end
        if column == self.START_TIME_COLUMN:
            return Time(self.items[row].start)
        if column == self.END_TIME_COLUMN:
            return Time(self.items[row].end)
        if column == self.LABEL_COLUMN:
            return self.items[row].label

    return None

get_next_frame 

get_next_frame(initial: Frame) -> Frame | None
Source code 
235
236
237
238
239
240
241
242
243
244
245
246
def get_next_frame(self, initial: Frame) -> Frame | None:
    result = None
    result_delta = Frame(int(self.max_value))
    for scene in self.items:
        if Frame(0) < scene.start - initial < result_delta:
            result = scene.start
            result_delta = scene.start - initial
        if Frame(0) < scene.end - initial < result_delta:
            result = scene.end
            result_delta = scene.end - initial

    return result

get_prev_frame 

get_prev_frame(initial: Frame) -> Frame | None
Source code 
222
223
224
225
226
227
228
229
230
231
232
233
def get_prev_frame(self, initial: Frame) -> Frame | None:
    result = None
    result_delta = Frame(int(self.max_value))
    for scene in reversed(self.items):
        if Frame(0) < initial - scene.start < result_delta:
            result = scene.start
            result_delta = scene.start - initial
        if Frame(0) < initial - scene.end < result_delta:
            result = scene.end
            result_delta = scene.end - initial

    return result

headerData 

headerData(
    section: int, orientation: Orientation, role: int = DisplayRole
) -> Any
Source code 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def headerData(self, section: int, orientation: Qt.Orientation, role: int = Qt.ItemDataRole.DisplayRole) -> Any:
    if role != Qt.ItemDataRole.DisplayRole:
        return None

    if orientation == Qt.Orientation.Horizontal:
        if section == self.START_FRAME_COLUMN:
            return 'Start'
        if section == self.END_FRAME_COLUMN:
            return 'End'
        if section == self.START_TIME_COLUMN:
            return 'Start'
        if section == self.END_TIME_COLUMN:
            return 'End'
        if section == self.LABEL_COLUMN:
            return 'Label'
    if orientation == Qt.Orientation.Vertical:
        return section + 1
    return None

remove 

remove(i: int | Scene) -> None
Source code 
211
212
213
214
215
216
217
218
219
220
def remove(self, i: int | Scene) -> None:
    if isinstance(i, Scene):
        i = self.items.index(i)

    if i >= 0 and i < len(self.items):
        self.beginRemoveRows(QModelIndex(), i, i)
        del self.items[i]
        self.endRemoveRows()
    else:
        raise IndexError

rowCount 

rowCount(parent: QModelIndex = QModelIndex()) -> int
Source code 
39
40
def rowCount(self, parent: QModelIndex = QModelIndex()) -> int:
    return len(self.items)

setData 

setData(index: QModelIndex, value: Any, role: int = EditRole) -> bool
Source code 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def setData(self, index: QModelIndex, value: Any, role: int = Qt.ItemDataRole.EditRole) -> bool:
    if not index.isValid():
        return False
    if role not in {Qt.ItemDataRole.EditRole, Qt.ItemDataRole.UserRole}:
        return False

    row = index.row()
    column = index.column()
    scene = deepcopy(self.items[row])

    if column == self.START_FRAME_COLUMN:
        if not isinstance(value, Frame):
            raise TypeError
        if value > scene.end:
            return False
        scene.start = value
        proper_update = True
    elif column == self.END_FRAME_COLUMN:
        if not isinstance(value, Frame):
            raise TypeError
        if value < scene.start:
            return False
        scene.end = value
        proper_update = True
    if column == self.START_TIME_COLUMN:
        if not isinstance(value, Time):
            raise TypeError
        frame = Frame(value)
        if frame > scene.end:
            return False
        scene.start = frame
        proper_update = True
    if column == self.END_TIME_COLUMN:
        if not isinstance(value, Time):
            raise TypeError
        frame = Frame(value)
        if frame < scene.start:
            return False
        scene.end = frame
        proper_update = True
    elif column == self.LABEL_COLUMN:
        if not isinstance(value, str):
            raise TypeError
        scene.label = value
        proper_update = False

    if proper_update is True:
        i = bisect_right(self.items, scene)
        if i > row:
            i -= 1
        if i != row:
            self.beginMoveRows(self.createIndex(row, 0), row, row, self.createIndex(i, 0), i)
            del self.items[row]
            self.items.insert(i, scene)
            self.endMoveRows()
        else:
            self.items[index.row()] = scene
            self.dataChanged.emit(index, index)
    else:
        self.items[index.row()] = scene
        self.dataChanged.emit(index, index)
    return True

setValue 

setValue(
    name: str = "",
    max_value: Frame | None = None,
    items: list[Scene] | None = None,
    *,
    temporary: bool = False
) -> None
Source code 
30
31
32
33
34
35
36
37
def setValue(self, name: str = '', max_value: Frame | None = None, items: list[Scene] | None = None, *, temporary: bool = False) -> None:
    super().__init__()
    self.name = name
    self.max_value = max_value if max_value is not None else Frame(2**31)
    self.items = items if items is not None else []
    self.temporary = temporary

    self.main = main_window()

SceningLists 

SceningLists(items: list[SceningList] | None = None)

Bases: QAbstractListModel, QYAMLObject

Methods:

Source code 
279
280
def __init__(self, items: list[SceningList] | None = None) -> None:
    self.setValue(items)

add 

add(
    name: str | None = None,
    max_value: Frame | None = None,
    i: int | None = None,
) -> tuple[SceningList, int]
Source code 
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
def add(
    self, name: str | None = None, max_value: Frame | None = None, i: int | None = None
) -> tuple[SceningList, int]:
    if max_value is None:
        max_value = self.main.current_output.total_frames - 1
    if i is None:
        i = len(self.items)

    self.beginInsertRows(QModelIndex(), i, i)
    if name is None:
        self.items.insert(i, SceningList(f'List {len(self.items) + 1}', max_value))
    else:
        self.items.insert(i, SceningList(name, max_value))
    self.endInsertRows()
    return self.items[i], i

add_list 

add_list(scening_list: SceningList) -> int
Source code 
366
367
368
369
370
371
def add_list(self, scening_list: SceningList) -> int:
    i = len(self.items)
    self.beginInsertRows(QModelIndex(), i, i)
    self.items.insert(i, scening_list)
    self.endInsertRows()
    return i

clean_items 

clean_items() -> None
Source code 
288
289
def clean_items(self) -> None:
    self.items = [item for item in self.items if not item.temporary]

data 

data(index: QModelIndex, role: int = UserRole) -> Any
Source code 
308
309
310
311
312
313
314
315
316
317
318
def data(self, index: QModelIndex, role: int = Qt.ItemDataRole.UserRole) -> Any:
    if not index.isValid():
        return None
    if index.row() >= len(self.items):
        return None

    if role in {Qt.ItemDataRole.DisplayRole, Qt.ItemDataRole.EditRole}:
        return self.items[index.row()].name
    if role == Qt.ItemDataRole.UserRole:
        return self.items[index.row()]
    return None

flags 

flags(index: QModelIndex) -> ItemFlag
Source code 
320
321
322
323
324
def flags(self, index: QModelIndex) -> Qt.ItemFlag:
    if not index.isValid():
        return Qt.ItemFlag.ItemIsEnabled

    return super().flags(index) | Qt.ItemFlag.ItemIsEditable

index_of 

index_of(item: SceningList, start_i: int = 0, end_i: int = 0) -> int
Source code 
300
301
302
303
def index_of(self, item: SceningList, start_i: int = 0, end_i: int = 0) -> int:
    if end_i == 0:
        end_i = len(self.items)
    return self.items.index(item, start_i, end_i)

insertRow 

insertRow(i: int, parent: QModelIndex = QModelIndex()) -> bool
Source code 
338
339
340
def insertRow(self, i: int, parent: QModelIndex = QModelIndex()) -> bool:
    self.add(i=i)
    return True

remove 

remove(item: int | SceningList) -> None
Source code 
373
374
375
376
377
378
379
380
381
382
383
def remove(self, item: int | SceningList) -> None:
    i = item
    if isinstance(i, SceningList):
        i = self.items.index(i)

    if i >= 0 and i < len(self.items):
        self.beginRemoveRows(QModelIndex(), i, i)
        del self.items[i]
        self.endRemoveRows()
    else:
        raise IndexError

removeRow 

removeRow(i: int, parent: QModelIndex = QModelIndex()) -> bool
Source code 
342
343
344
345
346
347
348
def removeRow(self, i: int, parent: QModelIndex = QModelIndex()) -> bool:
    try:
        self.remove(i)
    except IndexError:
        return False

    return True

rowCount 

rowCount(parent: QModelIndex = QModelIndex()) -> int
Source code 
305
306
def rowCount(self, parent: QModelIndex = QModelIndex()) -> int:
    return len(self.items)

setData 

setData(index: QModelIndex, value: Any, role: int = EditRole) -> bool
Source code 
326
327
328
329
330
331
332
333
334
335
336
def setData(self, index: QModelIndex, value: Any, role: int = Qt.ItemDataRole.EditRole) -> bool:
    if not index.isValid():
        return False
    if role not in {Qt.ItemDataRole.EditRole, Qt.ItemDataRole.UserRole}:
        return False
    if not isinstance(value, str):
        return False

    self.items[index.row()].name = value
    self.dataChanged.emit(index, index)
    return True

setValue 

setValue(items: list[SceningList] | None = None) -> None
Source code 
282
283
284
285
286
def setValue(self, items: list[SceningList] | None = None) -> None:
    super().__init__()
    self.main = main_window()
    self.main.reload_before_signal.connect(self.clean_items)
    self.items = (items if items is not None else []) + self.main.temporary_scenes