Differential D10290 Diff 34061 source/blender/blenkernel/BKE_node_ui_storage.hh

Changeset View

Standalone View

source/blender/blenkernel/BKE_node_ui_storage.hh

This file was added.

				/*
				* 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 2
				* 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.
				*/

				#pragma once

				#include "BLI_hash.hh"
				#include "BLI_map.hh"
				#include "BLI_session_uuid.h"

				#include "DNA_ID.h"
				#include "DNA_modifier_types.h"
				#include "DNA_session_uuid_types.h"

				struct bNode;
				struct bNodeTree;
				struct Object;
				struct ModifierData;

				/**
				* Contains the context necessary to determine when to display settings for a certain node tree
				* that may be used for multiple modifiers and objects. The object name and modifier session UUID
				* are used instead of pointers because they are re-allocated between allocations.
				JacquesLuckeUnsubmitted Done Inline Actions "re-allocates between allocations" doesn't sound quite right JacquesLucke: "re-allocates between allocations" doesn't sound quite right
				*
				* \note This does not yet handle the context of nested node trees.
				JacquesLuckeUnsubmitted Done Inline Actions It does not seem to handle node groups at all yet, does it? Seems like this should show one or two error messages on the Attribute Randomize node. JacquesLucke: It does not seem to handle node groups at all yet, does it? Seems like this should show one or…
				HooglyBooglyAuthorUnsubmitted Done Inline Actions I'm testing this now and I can't get it to work either. Got to check, probably the context check is failing again. HooglyBoogly: I'm testing this now and I can't get it to work either. Got to check, probably the context…
				*/
				struct NodeUIStorageContextModifier {
				std::string object_name;
				JacquesLuckeUnsubmitted Done Inline Actions Mention in a comment that name and session ids are used instead of pointers, so that they don't become dangling pointers. JacquesLucke: Mention in a comment that name and session ids are used instead of pointers, so that they don't…
				SessionUUID modifier_session_uuid;

				NodeUIStorageContextModifier(const Object &object, const ModifierData &modifier)
				JacquesLuckeUnsubmitted Done Inline Actions private fields should use a trailing underscore. Also consider adding an explicit `private:` JacquesLucke: private fields should use a trailing underscore. Also consider adding an explicit `private:`
				{
				object_name = reinterpret_cast<const ID &>(object).name;
				modifier_session_uuid = modifier.session_uuid;
				}

				uint64_t hash() const
				{
				const uint64_t hash1 = blender::DefaultHash<std::string>{}(object_name);
				const uint64_t hash2 = BLI_session_uuid_hash_uint64(&modifier_session_uuid);
				return hash1 ^ (hash2 * 33); /* Copied from DefaultHash for std::pair. */
				}

				bool operator==(const NodeUIStorageContextModifier &other) const
				{
				return other.object_name == object_name &&
				BLI_session_uuid_is_equal(&other.modifier_session_uuid, &modifier_session_uuid);
				}
				};

				enum class NodeWarningType {
				Error,
				Warning,
				Info,
				};

				struct NodeWarning {
				NodeWarningType type;
				std::string message;
				};

				struct NodeUIStorage {
				blender::Vector<NodeWarning> warnings;
				};

				struct NodeTreeUIStorage {
				blender::Map<std::string, blender::Map<NodeUIStorageContextModifier, NodeUIStorage>> node_map;
				};

				void BKE_nodetree_ui_storage_free(bNodeTree &ntree);

				void BKE_nodetree_ui_storage_add(bNodeTree &ntree);

				void BKE_nodetree_error_message_add(bNodeTree &ntree,
				const NodeUIStorageContextModifier &context,
				const bNode &node,
				const NodeWarningType type,
				std::string message);