Release v1.10.0

Author: webermm

CHANGELOG.md

@@ -24,6 +24,42 @@ If a copy of the MPL was not distributed with this file, You can obtain one at h
 
 -->
 
+## [1.10.0] Multiedit, Shader Includes, Drag-and-drop Support, Misc Usability Improvements and Bugfixes
+
+### Added
+* Added support for the multiple edit functionality in the property browser.
+* Added support for `#include` directives in shader files. Include directives can be nested. The path of the included files must be relative and will be interpreted relative to the path of the shader file containing the include.
+* Added support for opening `.rca` files using drag-and-drop.
+* Added drag-and-drop support for resource files (`.gltf`, `.glb`, `.ctm`, `.png`, `.vert`, `.frag`, `.geom`, `.def`, `.glsl`). Dropping a resource file on a URI property will fill the property. Dropping a resource file in the treeviews will create a new resource object.
+* Added application preference to optionally enable the case-sensitive URI validation. The default is off.
+* Added functionality to save screenshots of the preview using the GUI application and exposed via the Python API. 
+* Added `resolveUriPropertyToAbsolutePath` function to the Python API to obtain the absolute path from a uri property.
+* Added a feature level update python script and updated the python migration scripts in the `python` subdirectory.
+    * Use the `migrate_recursive_v1.0.1.py` script to update projects from RaCo version <=1.0.1 to the current version. Keeps feature level.
+    * Use the `migrate_recursive.py` script to update projects from RaCo version >=1.1.0 to the current version. Keeps feature level.
+    * Use the `upgrade_fl_recursive.py` script to perform a feature level upgrade to a specified feature level. Also updates the projects to the current RaCo version.
+    * All scripts will update the main project and all external projects used by it.
+    * Detailed usage information is contained in the scripts and can be obtained by running the script with the Python interpreter directly.
+* Added section on feature levels to the `Basics/Introduction` chapter of the documentation.
+
+### Changes
+* Top-level objects in the scenegraph are now moveable.
+* The folding state of non-locked property browsers is preserved and saved in a cache per session for all expandable properties.
+* Added a new confirmation dialog to prevent accidental file version upgrade on Save. The appearance of this dialog is controlled via a new option in the preferences dialog.
+* Adjust the behaviour of the `-f` commandline option in the GUI application to ensure that projects specified on the commandline will load regardless of the feature level set in the preferences dialog. The behaviour is now as follows:
+    * default feature level for new projects
+        * set via the preferences dialog in the GUI application
+        * set via the `-f` commdandline option in the headless application
+    * initial project load feature level
+        * set via the `-f` commdandline option in both gui and headless applications.
+        * if specified the initial project given using the `-p` option will be upgraded to the given feature level.
+        * if no initial project is specified the initial default project will be created with the given feature level.
+        * if no `-f` option is used the initial project given the `-p` option will be loaded at the feature level of the project itself.
+
+### Fixes
+* Don't optimize away `LuaInterfaces` with invalid links ending on them when exporting a scene. Note that invalid links ending on non-existing properties will not have associated error items indicating an invalid link.
+
+
 ## [1.9.1] Bugfix Release
 
 ### Fixes

CMakeLists.txt

@@ -11,7 +11,7 @@ cmake_minimum_required(VERSION 3.19)
 
 SET(CMAKE_CONFIGURATION_TYPES "Debug;RelWithDebInfo")
 
-project(RaCoOS VERSION 1.9.1)
+project(RaCoOS VERSION 1.10.0)
 
 SET(RACO_RELEASE_DIRECTORY ${CMAKE_BINARY_DIR}/release)
 
@@ -250,7 +250,7 @@ if(PACKAGE_TESTS)
 	# Define a macro to easily setup tests
 	macro(raco_package_add_test TESTNAME FILES LIBRARIES TEST_WORKING_DIRECTORY)
 	    add_executable(${TESTNAME} ${FILES})
-		target_link_libraries(${TESTNAME} gtest gmock gtest_main ${LIBRARIES} raco::ramses-logic-lib-client-only)
+		target_link_libraries(${TESTNAME} gtest gmock gtest_main ${LIBRARIES})
 		gtest_discover_tests(${TESTNAME}
 			WORKING_DIRECTORY "${TEST_WORKING_DIRECTORY}"
 			PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "${TEST_WORKING_DIRECTORY}"
@@ -277,13 +277,15 @@ if(PACKAGE_TESTS)
 	endmacro()
 	macro(raco_package_add_headless_test TESTNAME FILES LIBRARIES TEST_WORKING_DIRECTORY)
 		raco_package_add_qt_test(${TESTNAME} "${FILES}" "${LIBRARIES}" "${TEST_WORKING_DIRECTORY}")
+		target_link_libraries(${TESTNAME} raco::ramses-logic-lib-client-only)
 		deploy_headless_shared_dlls(${TESTNAME})
 		deploy_ramses_client_only_shared_dlls(${TESTNAME} "$<TARGET_FILE_DIR:${TESTNAME}>")
 	endmacro()
 	macro(raco_package_add_gui_test TESTNAME FILES LIBRARIES TEST_WORKING_DIRECTORY)
 		raco_package_add_qt_test(${TESTNAME} "${FILES}" "${LIBRARIES}" "${TEST_WORKING_DIRECTORY}")
+		target_link_libraries(${TESTNAME} raco::ramses-lib raco::ramses-logic-lib)
 		deploy_gui_shared_dlls(${TESTNAME})
-		deploy_ramses_client_only_shared_dlls(${TESTNAME} "$<TARGET_FILE_DIR:${TESTNAME}>")
+		deploy_ramses_with_renderer_shared_dlls(${TESTNAME} "$<TARGET_FILE_DIR:${TESTNAME}>")
 	endmacro()
 	function(raco_package_test_resources_process TESTNAME SOURCE_DIRECTORY)
 		foreach(fname ${ARGN}) 

EditorApp/main.cpp

@@ -168,15 +168,16 @@ int main(int argc, char* argv[]) {
 		projectFile = QFileInfo(positionalArgs.at(0)).absoluteFilePath();
 	}
 
+	int initialLoadFeatureLevel = -1;
 	raco::components::RaCoPreferences::init();
-	int featureLevel = std::min<int>(raco::components::RaCoPreferences::instance().featureLevel, static_cast<int>(raco::ramses_base::BaseEngineBackend::maxFeatureLevel));
+	int newFileFeatureLevel = std::min<int>(raco::components::RaCoPreferences::instance().featureLevel, static_cast<int>(raco::ramses_base::BaseEngineBackend::maxFeatureLevel));
 
 	if (parser.isSet(ramsesLogicFeatureLevel)) {
-		featureLevel = parser.value(ramsesLogicFeatureLevel).toInt();
-		if (!(featureLevel == -1 ||
-			featureLevel >= static_cast<int>(raco::ramses_base::BaseEngineBackend::minFeatureLevel) &&
-			featureLevel <= static_cast<int>(raco::ramses_base::BaseEngineBackend::maxFeatureLevel))) {
-			LOG_ERROR(raco::log_system::COMMON, fmt::format("RamsesLogic feature level {} outside valid range (-1, {} ... {})", featureLevel, static_cast<int>(raco::ramses_base::BaseEngineBackend::minFeatureLevel), static_cast<int>(raco::ramses_base::BaseEngineBackend::maxFeatureLevel)));
+		initialLoadFeatureLevel = parser.value(ramsesLogicFeatureLevel).toInt();
+		if (!(initialLoadFeatureLevel == -1 ||
+			initialLoadFeatureLevel >= static_cast<int>(raco::ramses_base::BaseEngineBackend::minFeatureLevel) &&
+			initialLoadFeatureLevel <= static_cast<int>(raco::ramses_base::BaseEngineBackend::maxFeatureLevel))) {
+			LOG_ERROR(raco::log_system::COMMON, fmt::format("RamsesLogic feature level {} outside valid range (-1, {} ... {})", initialLoadFeatureLevel, static_cast<int>(raco::ramses_base::BaseEngineBackend::minFeatureLevel), static_cast<int>(raco::ramses_base::BaseEngineBackend::maxFeatureLevel)));
 			exit(1);
         }
 	}
@@ -204,13 +205,13 @@ int main(int argc, char* argv[]) {
 	raco::style::RaCoStyle::installFont();
 
 	auto ramsesCommandLineArgs = parser.value(forwardCommandLineArgs).toStdString();
-	int initialFeatureLevel = featureLevel == -1 ? static_cast<int>(raco::ramses_base::BaseEngineBackend::maxFeatureLevel) : featureLevel;
+	int initialFeatureLevel = initialLoadFeatureLevel == -1 ? static_cast<int>(raco::ramses_base::BaseEngineBackend::maxFeatureLevel) : initialLoadFeatureLevel;
 	raco::ramses_widgets::RendererBackend rendererBackend{static_cast<rlogic::EFeatureLevel>(initialFeatureLevel), parser.isSet(forwardCommandLineArgs) ? ramsesCommandLineArgs : ""};
 
 	std::unique_ptr<raco::application::RaCoApplication> app;
 
 	try {
-		app = std::make_unique<raco::application::RaCoApplication>(rendererBackend, raco::application::RaCoApplicationLaunchSettings(projectFile, true, parser.isSet(ramsesTraceLogMessageAction), featureLevel, true));
+		app = std::make_unique<raco::application::RaCoApplication>(rendererBackend, raco::application::RaCoApplicationLaunchSettings(projectFile, true, parser.isSet(ramsesTraceLogMessageAction), newFileFeatureLevel, initialLoadFeatureLevel, true));
 	} catch (const raco::application::FutureFileVersion& error) {
 		LOG_ERROR(raco::log_system::COMMON, "File load error: project file was created with newer file version {} but current file version is {}.", error.fileVersion_, raco::serialization::RAMSES_PROJECT_FILE_VERSION);
 		app.reset();

EditorApp/mainwindow.cpp

@@ -77,7 +77,9 @@
 
 #include "DockAreaWidget.h"
 #include "ads_globals.h"
+#include "components/RaCoNameConstants.h"
 #include "python_api/PythonAPI.h"
+#include "utils/ZipUtils.h"
 
 #include <DockWidget.h>
 #include <IconProvider.h>
@@ -139,25 +141,28 @@ ads::CDockAreaWidget* createAndAddPreview(MainWindow* mainWindow, const char* do
 	previewWidget->displayScene(application->sceneBackendImpl()->currentSceneId(), backgroundColor);
 	previewWidget->setWindowFlags(Qt::Widget);
 
+	raco::gui_python_api::setupPreviewWindow(previewWidget);
+
 	auto* dock = createDockWidget(MainWindow::DockWidgetTypes::RAMSES_PREVIEW, mainWindow);
 	dock->setObjectName(dockObjName);
 	dock->setWidget(previewWidget);
 	QObject::connect(dock, &ads::CDockWidget::closed, [mainWindow]() {
 		mainWindow->setNewPreviewMenuEntryEnabled(true);
+		raco::gui_python_api::setupPreviewWindow(nullptr);
 	});
 	mainWindow->setNewPreviewMenuEntryEnabled(false);
 	return dockManager->addDockWidget(ads::CenterDockWidgetArea, dock);
 }
 
 void connectPropertyBrowserAndTreeDockManager(raco::property_browser::PropertyBrowserWidget* propertyBrowser, raco::object_tree::view::ObjectTreeDockManager& treeDockManager) {
-	QObject::connect(&treeDockManager, &raco::object_tree::view::ObjectTreeDockManager::newObjectTreeItemsSelected, propertyBrowser, &raco::property_browser::PropertyBrowserWidget::setValueHandles);
+	QObject::connect(&treeDockManager, &raco::object_tree::view::ObjectTreeDockManager::newObjectTreeItemsSelected, propertyBrowser, &raco::property_browser::PropertyBrowserWidget::setObjects);
 	QObject::connect(&treeDockManager, &raco::object_tree::view::ObjectTreeDockManager::selectionCleared, propertyBrowser, &raco::property_browser::PropertyBrowserWidget::clear);
 }
 
 ads::CDockAreaWidget* createAndAddPropertyBrowser(MainWindow* mainWindow, const char* dockObjName, RaCoDockManager* dockManager, raco::object_tree::view::ObjectTreeDockManager& treeDockManager, raco::application::RaCoApplication* application) {
-	auto propertyBrowser = new raco::property_browser::PropertyBrowserWidget(application->dataChangeDispatcher(), application->activeRaCoProject().commandInterface(), application->sceneBackendImpl(), mainWindow);
+	auto propertyBrowser = new raco::property_browser::PropertyBrowserWidget(application->dataChangeDispatcher(), application->activeRaCoProject().commandInterface(), application->sceneBackendImpl(), &treeDockManager, mainWindow);
 	QObject::connect(propertyBrowser->model(), &raco::property_browser::PropertyBrowserModel::objectSelectionRequested, mainWindow, &MainWindow::focusToObject);
-	QObject::connect(mainWindow, &MainWindow::objectFocusRequestedForPropertyBrowser, propertyBrowser, &raco::property_browser::PropertyBrowserWidget::setValueHandleFromObjectId);
+	QObject::connect(mainWindow, &MainWindow::objectFocusRequestedForPropertyBrowser, propertyBrowser, &raco::property_browser::PropertyBrowserWidget::setObjectFromObjectId);
 	connectPropertyBrowserAndTreeDockManager(propertyBrowser, treeDockManager);
 	auto* dockWidget = createDockWidget(MainWindow::DockWidgetTypes::PROPERTY_BROWSER, mainWindow);
 	dockWidget->setWidget(propertyBrowser);
@@ -168,8 +173,8 @@ ads::CDockAreaWidget* createAndAddPropertyBrowser(MainWindow* mainWindow, const
 void createAndAddProjectSettings(MainWindow* mainWindow, const char* dockObjName, RaCoDockManager* dockManager, raco::application::RaCoProject* project, SDataChangeDispatcher dataChangeDispatcher, CommandInterface* commandInterface, SceneBackend* sceneBackend) {
 	auto* dock = createDockWidget(MainWindow::DockWidgetTypes::PROJECT_SETTINGS, mainWindow);
 	dock->setObjectName(dockObjName);
-	auto propertyBrowser = new raco::property_browser::PropertyBrowserWidget(dataChangeDispatcher, commandInterface, sceneBackend, mainWindow);
-	propertyBrowser->setValueHandle({project->project()->settings()});
+	auto propertyBrowser = new raco::property_browser::PropertyBrowserWidget(dataChangeDispatcher, commandInterface, sceneBackend, nullptr, mainWindow);
+	propertyBrowser->setObjects({project->project()->settings()});
 	propertyBrowser->setLockable(false);
 	dock->setWidget(propertyBrowser);
 	dockManager->addDockWidget(ads::RightDockWidgetArea, dock);
@@ -229,6 +234,8 @@ ads::CDockAreaWidget* createAndAddResourceTree(MainWindow* mainWindow, const cha
 		RenderPass::typeDescription.typeName};
 
 	auto* model = new raco::object_tree::model::ObjectTreeViewResourceModel(racoApplication->activeRaCoProject().commandInterface(), racoApplication->dataChangeDispatcher(), racoApplication->externalProjects(), allowedCreateableUserTypes);
+	model->setAcceptableFileExtensions(QStringList{"gltf", "glb", "ctm", "png", "vert", "frag", "geom", "def", "glsl", "lua"});
+	model->setAcceptLuaModules(true);
 	return createAndAddObjectTree(
 		MainWindow::DockWidgetTypes::RESOURCES, dockObjName, model, new raco::object_tree::model::ObjectTreeViewResourceSortFilterProxyModel(mainWindow),
 		ads::BottomDockWidgetArea, mainWindow, dockManager, treeDockManager, dockArea);
@@ -238,16 +245,7 @@ ads::CDockAreaWidget* createAndAddPrefabTree(MainWindow* mainWindow, const char*
 	using namespace raco::user_types;
 
 	static const std::vector<std::string> allowedCreateableUserTypes{
-		Node::typeDescription.typeName,
-		MeshNode::typeDescription.typeName,
-		Prefab::typeDescription.typeName,
-		PrefabInstance::typeDescription.typeName,
-		OrthographicCamera::typeDescription.typeName,
-		PerspectiveCamera::typeDescription.typeName,
-		Animation::typeDescription.typeName,
-		LuaScript::typeDescription.typeName,
-		LuaInterface::typeDescription.typeName,
-		Skin::typeDescription.typeName};
+		Prefab::typeDescription.typeName};
 
 	auto* model = new raco::object_tree::model::ObjectTreeViewPrefabModel(racoApplication->activeRaCoProject().commandInterface(), racoApplication->dataChangeDispatcher(), racoApplication->externalProjects(), allowedCreateableUserTypes);
 
@@ -271,6 +269,9 @@ ads::CDockAreaWidget* createAndAddSceneGraphTree(MainWindow* mainWindow, const c
 		Skin::typeDescription.typeName};
 
 	auto* model = new raco::object_tree::model::ObjectTreeViewDefaultModel(racoApplication->activeRaCoProject().commandInterface(), racoApplication->dataChangeDispatcher(), racoApplication->externalProjects(), allowedCreateableUserTypes);
+	model->setAcceptableFileExtensions(QStringList{"lua"});
+	model->setAcceptLuaScripts(true);
+	model->setAcceptLuaInterfaces(true);
 	return createAndAddObjectTree(MainWindow::DockWidgetTypes::SCENE_GRAPH, dockObjName, model, new raco::object_tree::model::ObjectTreeViewDefaultSortFilterProxyModel(mainWindow, false),
 		ads::LeftDockWidgetArea, mainWindow, dockManager, treeDockManager, nullptr);
 }
@@ -446,6 +447,7 @@ MainWindow::MainWindow(raco::application::RaCoApplication* racoApplication, raco
 		dialog->resize(500, 500);
 		dialog->exec();
 		racoApplication_->setApplicationFeatureLevel(raco::components::RaCoPreferences::instance().featureLevel);
+		racoApplication_->activeRaCoProject().applyPreferences();
 	});
 
 	// View actions
@@ -500,6 +502,8 @@ MainWindow::MainWindow(raco::application::RaCoApplication* racoApplication, raco
 
 	QObject::connect(this, &MainWindow::objectFocusRequestedForTreeDock, &treeDockManager_, &raco::object_tree::view::ObjectTreeDockManager::selectObjectAcrossAllTreeDocks);
 
+	setAcceptDrops(true);
+
 	updateProjectSavedConnection();
 
 	restoreSettings();
@@ -508,7 +512,8 @@ MainWindow::MainWindow(raco::application::RaCoApplication* racoApplication, raco
 	// Setup
 	updateApplicationTitle();
 	updateSavedLayoutMenu();
-	raco::gui_python_api::setup(&treeDockManager_);
+
+	raco::gui_python_api::setupObjectTree(&treeDockManager_);
 
 	// Will we support Mac?
 	setUnifiedTitleAndToolBarOnMac(true);
@@ -567,6 +572,35 @@ void MainWindow::closeEvent(QCloseEvent* event) {
 	}
 }
 
+void MainWindow::dragEnterEvent(QDragEnterEvent* event) {
+	const QFileInfo fileInfo = getDragAndDropFileInfo(event);
+	if (fileInfo.suffix().toLower() == "rca") {
+		event->acceptProposedAction();
+	}
+}
+
+void MainWindow::dropEvent(QDropEvent* event) {
+	const QFileInfo fileInfo = getDragAndDropFileInfo(event);
+	if (fileInfo.suffix().toLower() == "rca") {
+		openProject(fileInfo.absoluteFilePath());
+	}
+}
+
+QFileInfo MainWindow::getDragAndDropFileInfo(const QDropEvent* event) {
+	const QList<QUrl> urls = event->mimeData()->urls();
+	if (urls.empty()) {
+		return {};
+	}
+
+	const QString filePath = urls.first().toLocalFile();
+	if (filePath.isEmpty()) {
+		return {};
+	}
+
+	const QFile file(filePath);
+	return QFileInfo{file};
+}
+
 void MainWindow::restoreSettings() {
 	if (PathManager::layoutFilePath().existsFile()) {
 		auto settings = raco::core::PathManager::layoutSettings();
@@ -715,6 +749,10 @@ bool MainWindow::saveActiveProject() {
 		if (racoApplication_->activeProjectPath().empty()) {
 			return saveAsActiveProject();
 		} else {
+			if (isUpgradePrevented()) {
+				return false;
+			}
+
 			std::string errorMsg;
 			if (racoApplication_->activeRaCoProject().save(errorMsg)) {
 				updateUpgradeMenu();
@@ -731,6 +769,26 @@ bool MainWindow::saveActiveProject() {
 	return false;
 }
 
+bool MainWindow::isUpgradePrevented() {
+	if (raco::components::RaCoPreferences::instance().preventAccidentalUpgrade) {
+		const auto filename = QString::fromStdString(racoApplication_->activeProjectPath());
+		constexpr auto currentFileVersion = raco::serialization::RAMSES_PROJECT_FILE_VERSION;
+		
+		try {
+			auto previousFileVersion = raco::serialization::deserializeFileVersion(raco::application::RaCoProject::loadFileDocument(filename));
+			if (currentFileVersion > previousFileVersion) {
+				const auto answer = QMessageBox::warning(this, "Save File Warning", fmt::format("The project with the file version {} will be overwritten with the file version {}. Are you sure you want to save it with the new file version", previousFileVersion, currentFileVersion).c_str(), QMessageBox::Save, QMessageBox::Cancel);
+				if (answer == QMessageBox::Cancel) {
+					return true;
+				}
+			}
+		} catch (const std::exception& e) {
+			QMessageBox::warning(this, "Document Load Error", fmt::format("Document could not be loaded.\n\nReported error: {}\n\nCheck whether the file has been broken or corrupted.", e.what()).c_str(), QMessageBox::Close);
+		}
+	}
+	return false;
+}
+
 bool MainWindow::saveAsActiveProject(bool newID) {
 	if (racoApplication_->canSaveActiveProject()) {
 		const bool setProjectName = racoApplication_->activeProjectPath().empty();

EditorApp/mainwindow.h

@@ -73,6 +73,8 @@ public Q_SLOTS:
 protected:
 	void timerEvent(QTimerEvent* event) override;
 	void closeEvent(QCloseEvent* event) override;
+	void dragEnterEvent(QDragEnterEvent* event) override;
+	void dropEvent(QDropEvent* event) override;
 	void restoreSettings();
 	/** @returns if user canceled the dirty resolution */
 	bool resolveDirtiness();
@@ -81,6 +83,7 @@ public Q_SLOTS:
 	void restoreCustomLayout(const QString& layoutName);
 	void regenerateLayoutDocks(const RaCoDockManager::LayoutDocks& docks);
 	void saveDockManagerCustomLayouts();
+	bool isUpgradePrevented();
 
 protected Q_SLOTS:
 	void openProject(const QString& file = {}, int featureLevel = -1, bool generateNewObjectIDs = false);
@@ -115,4 +118,6 @@ protected Q_SLOTS:
 	std::map<QString, qint64> pythonScriptArgumentCache_;
 
 	int renderTimerId_ = 0;
+
+	QFileInfo getDragAndDropFileInfo(const QDropEvent* event);
 };