-
Notifications
You must be signed in to change notification settings - Fork 3
/
preview_helper.py
121 lines (99 loc) · 3.39 KB
/
preview_helper.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# Copyright (C) 2019 h0bB1T
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
#
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import bpy, os
from .t3dn_bip import previews
class CollectionList:
"""
Stores all information about a single collection. The parser is used
to parse a new list based on the data. The structure of "data" is parser specific.
"""
def __init__(self, parser, data):
self.parser = parser
self.data = data
self.mustScan = True
self.collection = None
self.items = []
def reset(self):
"""
Delete items and collection (if allocated).
"""
self.items.clear()
if self.collection:
previews.remove(self.collection)
class PreviewHelper:
"""
Helper class to manage the lifecycle of different preview items. Able to reparse
using a parser.
"""
collections = {}
@staticmethod
def addCollection(name, parser, data):
"""
Add a new collection, identified by "name". The parser is used to build
the item list using the given data.
"""
PreviewHelper.collections[name] = CollectionList(parser, data)
@staticmethod
def scanCollection(lst):
"""
Scans the items according to parser and the current data.
"""
lst.mustScan = False
lst.reset()
lst.parser.parse(lst)
@staticmethod
def getCollection(name):
"""
Return the collection identified by name. If outdated (by default), parse it.
"""
lst = PreviewHelper.collections[name]
if lst.mustScan:
PreviewHelper.scanCollection(lst)
return lst
@staticmethod
def getDynamicCollection(name, parser, data):
if name not in PreviewHelper.collections:
PreviewHelper.collections[name] = CollectionList(parser, data)
lst = PreviewHelper.collections[name]
if lst.data != data:
lst.data = data
lst.mustScan = True
if lst.mustScan:
PreviewHelper.scanCollection(lst)
return lst
@staticmethod
def setData(name, data, forceUpdate=False):
"""
Adjust data for collection, may result in reparsing.
"""
lst = PreviewHelper.collections[name]
if lst.data != data or forceUpdate:
lst.data = data
lst.mustScan = True
@staticmethod
def forceUpdate(name):
"""
Force update for specific collection.
"""
PreviewHelper.collections[name].mustScan = True
@staticmethod
def removeAllCollections():
"""
Cleanup method, removes all collections.
"""
for lst in PreviewHelper.collections.values():
lst.reset()
PreviewHelper.collections.clear()