class BaseFileFolderDialog(BaseDialog,
abstract_dialog.AbstractFileFolderDialog):
"""
Base dialog classes for folders and files
"""
def_title = 'Select File'
def_size = (200, 125)
def_use_app_browser = False
def __init__(self, name='BaseFileFolder', parent=None, **kwargs):
super(BaseFileFolderDialog, self).__init__(name=name, parent=parent)
self.directory = None
self.filters = None
self._use_app_browser = kwargs.pop('use_app_browser',
self.def_use_app_browser)
self.set_filters('All Files (*.*)')
# By default, we set the directory to the user folder
self.set_directory(os.path.expanduser('~'))
self.center()
def open_app_browser(self):
return
def ui(self):
super(BaseFileFolderDialog, self).ui()
from tpDcc.libs.qt.widgets import directory
self.places = dict()
self.grid = layouts.GridLayout()
sub_grid = layouts.GridLayout()
self.grid.addWidget(QLabel('Path:'), 0, 0, Qt.AlignRight)
self.path_edit = QLineEdit(self)
self.path_edit.setReadOnly(True)
self.filter_box = QComboBox(self)
self.file_edit = QLineEdit(self)
self.view = directory.FileListWidget(self)
self.view.setWrapping(True)
self.view.setFocusPolicy(Qt.StrongFocus)
self.open_button = QPushButton('Select', self)
self.cancel_button = QPushButton('Cancel', self)
size = QSize(32, 24)
self.up_button = QPushButton('Up')
self.up_button.setToolTip('Go up')
self.up_button.setMinimumSize(size)
self.up_button.setMaximumSize(size)
size = QSize(56, 24)
self.refresh_button = QPushButton('Reload')
self.refresh_button.setToolTip('Reload file list')
self.refresh_button.setMinimumSize(size)
self.refresh_button.setMaximumSize(size)
self.show_hidden = QCheckBox('Hidden')
self.show_hidden.setChecked(False)
self.show_hidden.setToolTip('Toggle show hidden files')
sub_grid.addWidget(self.up_button, 0, 1)
sub_grid.addWidget(self.path_edit, 0, 2)
sub_grid.addWidget(self.refresh_button, 0, 3)
sub_grid.addWidget(self.show_hidden, 0, 4)
self.grid.addLayout(sub_grid, 0, 1)
self.grid.addWidget(self.get_drives_widget(), 1, 0)
self.grid.addWidget(self.view, 1, 1)
self.grid.addWidget(QLabel('File name:'), 7, 0, Qt.AlignRight)
self.grid.addWidget(self.file_edit, 7, 1)
self.filter_label = QLabel('Filter:')
self.grid.addWidget(self.filter_label, 8, 0, Qt.AlignRight)
self.grid.addWidget(self.filter_box, 8, 1)
hbox = layouts.GridLayout()
hbox.addWidget(self.open_button, 0, 0, Qt.AlignRight)
hbox.addWidget(self.cancel_button, 0, 1, Qt.AlignRight)
self.grid.addLayout(hbox, 9, 1, Qt.AlignRight)
self.main_layout.addLayout(self.grid)
self.setGeometry(200, 100, 600, 400)
self.open_button.clicked.connect(self.accept)
self.cancel_button.clicked.connect(self.reject)
self.up_button.clicked.connect(self.go_up)
self.refresh_button.clicked.connect(self.update_view)
self.show_hidden.stateChanged.connect(self.update_view)
self.view.directory_activated.connect(
self.activate_directory_from_view)
self.view.file_activated.connect(self.activate_file_from_view)
self.view.file_selected.connect(self.select_file_item)
self.view.folder_selected.connect(self.select_folder_item)
self.view.up_requested.connect(self.go_up)
self.view.update_requested.connect(self.update_view)
def exec_(self, *args, **kwargs):
if self._use_app_browser:
return self.open_app_browser()
else:
self.update_view()
self.filter_box.currentIndexChanged.connect(self.update_view)
accepted = super(BaseFileFolderDialog, self).exec_()
self.filter_box.currentIndexChanged.disconnect(self.update_view)
return self.get_result() if accepted == 1 else None
def set_filters(self, filters, selected=0):
self.filter_box.clear()
filter_types = filters.split(';;')
for ft in filter_types:
extensions = string.extract(ft, '(', ')')
filter_name = string.rstrips(ft, '({})'.format(extensions))
extensions = extensions.split(' ')
self.filter_box.addItem(
'{} ({})'.format(filter_name, ','.join(extensions)),
extensions)
if 0 <= selected < self.filter_box.count():
self.filter_box.setCurrentIndex(selected)
self.filters = filters
def get_drives_widget(self):
"""
Returns a QGroupBox widget that contains all disk drivers of the PC in a vertical layout
:return: QGroupBox
"""
w = QGroupBox('')
w.setParent(self)
box = layouts.VerticalLayout()
box.setAlignment(Qt.AlignTop)
places = [(getpass.getuser(),
os.path.realpath(os.path.expanduser('~')))]
places += [
(q, q) for q in
[os.path.realpath(x.absolutePath()) for x in QDir().drives()]
]
for label, loc in places:
icon = QFileIconProvider().icon(QFileInfo(loc))
drive_btn = QRadioButton(label)
drive_btn.setIcon(icon)
drive_btn.setToolTip(loc)
drive_btn.setProperty('path', loc)
drive_btn.clicked.connect(self.go_to_drive)
self.places[loc] = drive_btn
box.addWidget(drive_btn)
w.setLayout(box)
return w
def go_to_drive(self):
"""
Updates widget to show the content of the selected disk drive
"""
sender = self.sender()
self.set_directory(sender.property('path'), False)
def get_result(self):
tf = self.file_edit.text()
sf = self.get_file_path(tf)
return sf, os.path.dirname(sf), tf.split(os.pathsep)
def get_filter_patterns(self):
"""
Get list of filter patterns that are being used by the widget
:return: list<str>
"""
idx = self.filter_box.currentIndex()
if idx >= 0:
return self.filter_box.itemData(idx)
else:
return []
def get_file_path(self, file_name):
"""
Returns file path of the given file name taking account the selected directory
:param file_name: str, name of the file without path
:return: str
"""
sname = file_name.split(os.pathsep)[0]
return os.path.realpath(
os.path.join(os.path.abspath(self.directory), sname))
# def accept(self):
# self._overlay.close()
# super(BaseFileFolderDialog, self).accept()
#
#
# def reject(self):
# self._overlay.close()
# super(BaseFileFolderDialog, self).reject()
def update_view(self):
"""
Updates file/folder view
:return:
"""
self.view.clear()
qdir = QDir(self.directory)
qdir.setNameFilters(self.get_filter_patterns())
filters = QDir.Dirs | QDir.AllDirs | QDir.Files | QDir.NoDot | QDir.NoDotDot
if self.show_hidden.isChecked():
filters = filters | QDir.Hidden
entries = qdir.entryInfoList(filters=filters,
sort=QDir.DirsFirst | QDir.Name)
file_path = self.get_file_path('..')
if os.path.exists(file_path) and file_path != self.directory:
icon = QFileIconProvider().icon(QFileInfo(self.directory))
QListWidgetItem(icon, '..', self.view, 0)
for info in entries:
icon = QFileIconProvider().icon(info)
suf = info.completeSuffix()
name, tp = (info.fileName(), 0) if info.isDir() else (
'%s%s' % (info.baseName(), '.%s' % suf if suf else ''), 1)
QListWidgetItem(icon, name, self.view, tp)
self.view.setFocus()
def set_directory(self, path, check_drive=True):
"""
Sets the directory that you want to explore
:param path: str, valid path
:param check_drive: bool,
:return:
"""
self.directory = os.path.realpath(path)
self.path_edit.setText(self.directory)
self.file_edit.setText('')
# If necessary, update selected disk driver
if check_drive:
for loc in self.places:
rb = self.places[loc]
rb.setAutoExclusive(False)
rb.setChecked(loc.lower() == self.directory.lower())
rb.setAutoExclusive(True)
self.update_view()
self.up_button.setEnabled(not self.cant_go_up())
def go_up(self):
"""
Updates the current directory to go to its parent directory
"""
self.set_directory(os.path.dirname(self.directory))
def cant_go_up(self):
"""
Checks whether we can naviage to current selected parent directory or not
:return: bool
"""
return os.path.dirname(self.directory) == self.directory
def activate_directory_from_view(self, name):
"""
Updates selected directory
:param name: str, name of the directory
"""
self.set_directory(os.path.join(self.directory, name))
def activate_file_from_view(self, name):
"""
Updates selected file text and returns its info by accepting it
:param name: str, name of the file
"""
self.select_file_item(name=name)
self.accept()
def select_file_item(self, name):
"""
Updates selected file text and returns its info by accepting it
:param name: str, name of the file
"""
self.file_edit.setText(name)
def select_folder_item(self, name):
"""
Updates selected folder text and returns its info by accepting it
:param name: str, name of the folder
"""
self.file_edit.setText(name)
class BaseSaveFileDialog(BaseFileFolderDialog, object):
def __init__(self,
name='SaveFile',
title='Save File',
size=(200, 125),
fixed_size=False,
frame_less=True,
hide_title=False,
parent=None,
use_app_browser=False):
parent = parent or dcc.get_main_window()
super(BaseSaveFileDialog,
self).__init__(name=name,
title=title,
size=size,
fixed_size=fixed_size,
frame_less=frame_less,
hide_title=hide_title,
use_app_browser=use_app_browser,
parent=parent)
self._open_button.setText('Save')
size = QSize(42, 24)
self.new_directory_button = QPushButton('New')
self.new_directory_button.setToolTip('Create new directory')
self.new_directory_button.setMinimumSize(size)
self.new_directory_button.setMaximumWidth(size)
self.new_directory_button.clicked.connect(self.create_new_directory)
self.grid.itemAtPosition(0, 1).addWidget(self.new_directory_button, 0,
5)
def accept(self, *args, **kwargs):
selected_file, selected_dir, selected_filename = self.get_result()
if not os.path.isdir(selected_file):
if os.path.exists(selected_file):
message_box = QMessageBox()
message_box.setWindowTitle('Confirm File Selection')
message_box.setText(
'File "%s" exists.\nDo you want to overwrite it?' %
selected_file)
message_box.setStandardButtons(QMessageBox.Yes
| QMessageBox.No)
message_box.setDefaultButton(QMessageBox.No)
rv = message_box.exec_()
if rv == QMessageBox.Yes and not os.path.isdir(selected_file):
super(BaseSaveFileDialog, self).accept()
else:
super(BaseSaveFileDialog, self).accept()
def create_new_directory(self):
name, ok = QInputDialog.getText(self, 'New directory name', 'Name:',
QLineEdit.Normal, 'New Directory')
if ok and name:
path = os.path.join(self.directory, name)
if os.path.exists(path):
msg_box = QMessageBox(self)
msg_box.setWindowTitle('Error')
msg_box.setText('Directory already exists')
msg_box.exec_()
else:
try:
os.makedirs(path)
self.update_view()
except os.error as e:
msg_box = QMessageBox(self)
msg_box.setWindowTitle('Error')
msg_box.setText('Cannot create directory')
msg_box.exec_()
class SaveWidget(BaseSaveWidget, object):
def __init__(self, item, settings, temp_path=None, parent=None):
self._script_job = None
self._sequence_path = None
self._icon_path = ''
super(SaveWidget, self).__init__(item=item,
settings=settings,
temp_path=temp_path,
parent=parent)
self.create_sequence_widget()
self.update_thumbnail_size()
try:
self._on_selection_changed()
# self.set_script_job_enabled(True)
except NameError as e:
LOGGER.error('{} | {}'.format(e, traceback.format_exc()))
def ui(self):
super(SaveWidget, self).ui()
model_panel_layout = layouts.HorizontalLayout()
model_panel_layout.setContentsMargins(0, 0, 0, 0)
model_panel_layout.setSpacing(0)
thumbnail_layout = layouts.VerticalLayout()
thumbnail_layout.setContentsMargins(0, 0, 0, 0)
thumbnail_layout.setSpacing(0)
self._thumbnail_frame = QFrame()
self._thumbnail_frame.setMinimumSize(QSize(50, 50))
self._thumbnail_frame.setMaximumSize(QSize(150, 150))
self._thumbnail_frame.setSizePolicy(QSizePolicy.Expanding,
QSizePolicy.Expanding)
self._thumbnail_frame.setFrameShape(QFrame.NoFrame)
self._thumbnail_frame.setFrameShadow(QFrame.Plain)
self._thumbnail_frame.setLineWidth(0)
self._thumbnail_frame.setLayout(thumbnail_layout)
model_panel_layout.addWidget(self._thumbnail_frame)
self._thumbnail_btn = QPushButton()
self._thumbnail_btn.setMinimumSize(QSize(0, 0))
self._thumbnail_btn.setSizePolicy(QSizePolicy.Expanding,
QSizePolicy.Expanding)
self._thumbnail_btn.setMaximumSize(QSize(150, 150))
self._thumbnail_btn.setToolTip('Take snapshot')
self._thumbnail_btn.setStyleSheet(
'color: rgb(40, 40, 40);border: 0px solid rgb(0, 0, 0, 150);background-color: rgb(254, 255, 230, 200);'
)
self._thumbnail_btn.setIcon(resources.icon('thumbnail'))
self._thumbnail_btn.setToolTip("""
Click to capture a thumbnail from the current viewport.\n
CTRL + Click to show the capture window for better framing
""")
thumbnail_layout.addWidget(self._thumbnail_btn)
self._extra_layout.addLayout(model_panel_layout)
def setup_signals(self):
super(SaveWidget, self).setup_signals()
self._thumbnail_btn.clicked.connect(self._on_thumbnail_capture)
def resizeEvent(self, event):
"""
Overrides base QWidget resizeEvent function
:param event: QResizeEvent
"""
self.update_thumbnail_size()
def icon_path(self):
"""
Returns the icon path to be used for the thumbnail
:return: str
"""
return self._icon_path
def set_icon(self, icon):
"""
Sets the icon for the create widget thumbnail
:param icon: QIcon
"""
self._thumbnail_btn.setIcon(icon)
self._thumbnail_btn.setIconSize(QSize(200, 200))
self._thumbnail_btn.setText('')
def sequence_path(self):
"""
Returns the playblast path
:return: str
"""
return self._sequence_path
def set_sequence_path(self, path):
"""
Sets the disk location for the image sequence to be saved
:param path: str
"""
self._sequence_path = path
self._thumbnail_btn.set_dirname(os.path.dirname(path))
def create_sequence_widget(self):
"""
Creates a sequence widget to replace the static thumbnail widget
"""
sequence_widget = widgets.LibraryImageSequenceWidget(self)
sequence_widget.setObjectName('thumbnailButton')
sequence_widget.setStyleSheet(self._thumbnail_btn.styleSheet())
sequence_widget.setToolTip(self._thumbnail_btn.toolTip())
camera_icon = resources.get('icons', 'camera.svg')
expand_icon = resources.get('icons', 'expand.svg')
folder_icon = resources.get('icons', 'folder.svg')
sequence_widget.addAction(camera_icon, 'Capture new image',
'Capture new image',
self._on_thumbnail_capture)
sequence_widget.addAction(expand_icon, 'Show Capture window',
'Show Capture window',
self._on_show_capture_window)
sequence_widget.addAction(folder_icon, 'Load image from disk',
'Load image from disk',
self._on_show_browse_image_dialog)
sequence_widget.setIcon(resources.icon('thumbnail2'))
self._thumbnail_frame.layout().insertWidget(0, sequence_widget)
self._thumbnail_btn.hide()
self._thumbnail_btn = sequence_widget
self._thumbnail_btn.clicked.connect(self._on_thumbnail_capture)
def set_sequence(self, source):
"""
Sets the sequenced path for the thumbnail widget
:param source: str
"""
self.set_thumbnail(source, sequence=True)
def set_thumbnail(self, source, sequence=False):
"""
Sets the thumbnail
:param source: str
:param sequence: bool
"""
source = os.path.normpath(source)
# TODO: Find a way to remove temp folder afteer saving the file
# filename, extension = os.path.splitext(source)
# with path_utils.temp_dir() as dir_path:
# dir_path = path_utils.temp_dir()
# target = os.path.join(dir_path, 'thumbnail{}'.format(extension))
# shutil.copyfile(source, target)
# tpQtLib.logger.debug('Source Thumbnail: {}'.format(source))
# tpQtLib.logger.debug('Target Thumbnail: {}'.format(target))
# self._icon_path = target
# self._thumbnail_btn.set_path(target)
self._icon_path = source
self._thumbnail_btn.set_path(source)
if sequence:
self.set_sequence_path(source)
def update_thumbnail_size(self):
"""
Updates the thumbnail button to teh size of the widget
"""
width = self.width() - 10
if width > 250:
width = 250
size = QSize(width, width)
self._thumbnail_btn.setIconSize(size)
self._thumbnail_btn.setMaximumSize(size)
self._thumbnail_frame.setMaximumSize(size)
def show_by_frame_dialog(self):
"""
Show the by frame dialog
"""
help_text = """
To help speed up the playblast you can set the "by frame" to another greather than 1.
For example if the "by frame" is set to 2 it will playblast every second frame
"""
options = self._options_widget.values()
by_frame = options.get('byFrame', 1)
start_frame, end_frame = options.get('frameRange', [None, None])
duration = 1
if start_frame is not None and end_frame is not None:
duration = end_frame - start_frame
if duration > 100 and by_frame == 1:
buttons = QDialogButtonBox.Ok | QDialogButtonBox.Cancel
result = messagebox.MessageBox.question(
self.library_window(),
title='Tip',
text=help_text,
buttons=buttons,
enable_dont_show_checkbox=True)
if result != QDialogButtonBox.Ok:
raise Exception('Cancelled by user')
def show_thumbnail_capture_dialog(self):
"""
Asks the user if they would like to capture a thumbnail
:return: int
"""
buttons = QDialogButtonBox.Yes | QDialogButtonBox.Ignore | QDialogButtonBox.Cancel
parent = self.item().library_window()
btn = messagebox.MessageBox.question(
None,
'Create a thumbnail',
'Would you like to capture a thumbnail?',
buttons=buttons)
if btn == QDialogButtonBox.Yes:
self.thumbnail_capture()
return btn
def thumbnail_capture(self, show=False):
"""
Captures a playblast and saves it to the temporal thumbnail path
:param show: bool
"""
options = self._options_widget.values()
start_frame, end_frame = options.get('frameRange', [None, None])
step = options.get('byFrame', 1)
if not qtutils.is_control_modifier():
self.show_by_frame_dialog()
if not self._temp_path or not os.path.isdir(self._temp_path):
self._temp_path = tempfile.mkdtemp()
self._temp_path = os.path.join(self._temp_path, 'thumbnail.jpg')
try:
snapshot.SnapshotWindow(path=self._temp_path,
on_save=self._on_thumbnail_captured)
# thumbnail.ThumbnailCaptureDialog.thumbnail_capture(
# path=self._temp_path,
# show=show,
# start_frame=start_frame,
# end_frame=end_frame,
# step=step,
# clear_cache=False,
# captured=self._on_thumbnail_captured
# )
except Exception as e:
messagebox.MessageBox.critical(self.library_window(),
'Error while capturing thumbnail',
str(e))
LOGGER.error(traceback.format_exc())
def save(self, path, icon_path, objects=None):
"""
Saves the item with the given objects to the given disk location path
:param path: list(str)
:param icon_path: str
:param objects: str
"""
item = self.item()
options = self._options_widget.values()
sequence_path = self.sequence_path()
if sequence_path:
sequence_path = os.path.dirname(sequence_path)
item.save(path=path,
objects=objects,
icon_path=icon_path,
sequence_path=sequence_path,
**options)
self.close()
def _on_selection_changed(self):
"""
Internal callback functino that is called when DCC selection changes
"""
if self._options_widget:
self._options_widget.validate()
def _on_thumbnail_capture(self):
self.thumbnail_capture(show=False)
def _on_thumbnail_captured(self, captured_path):
"""
Internal callback function that is called when thumbnail is captured
:param captured_path: str
"""
self.set_sequence(captured_path)
def _on_show_capture_window(self):
"""
Internal callback function that shows the capture window for framing
"""
self.thumbnail_capture(show=True)
def _on_show_browse_image_dialog(self):
"""
Internal callback function that shows a file dialog for choosing an image from disk
"""
file_dialog = QFileDialog(self,
caption='Open Image',
filter='Image Files (*.png *.jpg)')
file_dialog.fileSelected.connect(self.set_thumbnail)
file_dialog.exec_()
