oak-editor/engine/node/group/group.h

/***

  Olive - Non-Linear Video Editor
  Copyright (C) 2022 Olive Team
  Modifications Copyright (C) 2025 mikesolar

  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, see <http://www.gnu.org/licenses/>.

***/

#ifndef OAK_NODEGROUP_H
#define OAK_NODEGROUP_H

#include "node/node.h"

namespace olive
{

class NodeGroup : public Node {
	Q_OBJECT
public:
	NodeGroup();

	NODE_DEFAULT_FUNCTIONS(NodeGroup)

	virtual QString name() const override;
	virtual QString id() const override;
	virtual QVector<CategoryID> category() const override;
	virtual QString description() const override;

	virtual void retranslate() override;

	virtual bool load_custom(QXmlStreamReader *reader,
							SerializedData *data) override;
	virtual void save_custom(QXmlStreamWriter *writer) const override;
	virtual void PostLoadEvent(SerializedData *data) override;

	QString add_input_passthrough(const NodeInput &input,
								const QString &force_id = QString());

	void remove_input_passthrough(const NodeInput &input);

	Node *get_output_passthrough() const
	{
		return output_passthrough_;
	}

	void set_output_passthrough(Node *node);

	using InputPassthrough = QPair<QString, NodeInput>;
	using InputPassthroughs = QVector<InputPassthrough>;
	const InputPassthroughs &get_input_passthroughs() const
	{
		return input_passthroughs_;
	}

	bool contains_input_passthrough(const NodeInput &input) const;

	virtual QString get_input_name(const QString &id) const override;

	static NodeInput resolve_input(NodeInput input);
	static bool get_inner(NodeInput *input);

	QString get_id_of_passthrough(const NodeInput &input) const
	{
		for (auto it = input_passthroughs_.cbegin();
			 it != input_passthroughs_.cend(); it++) {
			if (it->second == input) {
				return it->first;
			}
		}
		return QString();
	}

	NodeInput get_input_from_id(const QString &id) const
	{
		for (auto it = input_passthroughs_.cbegin();
			 it != input_passthroughs_.cend(); it++) {
			if (it->first == id) {
				return it->second;
			}
		}
		return NodeInput();
	}

signals:
	void input_passthrough_added(olive::NodeGroup *group,
							   const olive::NodeInput &input);

	void input_passthrough_removed(olive::NodeGroup *group,
								 const olive::NodeInput &input);

	void output_passthrough_changed(olive::NodeGroup *group, olive::Node *output);

private:
	InputPassthroughs input_passthroughs_;

	Node *output_passthrough_;
};

class NodeGroupAddInputPassthrough : public UndoCommand {
public:
	NodeGroupAddInputPassthrough(NodeGroup *group, const NodeInput &input,
								 const QString &force_id = QString())
		: group_(group)
		, input_(input)
		, actually_added_(false)
	{
	}

	virtual Project *get_relevant_project() const override
	{
		return group_->project();
	}

protected:
	virtual void redo() override;

	virtual void undo() override;

private:
	NodeGroup *group_;

	NodeInput input_;

	QString force_id_;

	bool actually_added_;
};

class NodeGroupSetOutputPassthrough : public UndoCommand {
public:
	NodeGroupSetOutputPassthrough(NodeGroup *group, Node *output)
		: group_(group)
		, new_output_(output)
	{
	}

	virtual Project *get_relevant_project() const override
	{
		return group_->project();
	}

protected:
	virtual void redo() override;

	virtual void undo() override;

private:
	NodeGroup *group_;

	Node *new_output_;
	Node *old_output_;
};

}

#endif // OAK_NODEGROUP_H