Code/EditorPlugins/VisualScript/EditorPluginVisualScript/VisualScriptGraph/VisualScriptGraph.h - dev - redgpu/ezEngine

Code/EditorPlugins/VisualScript/EditorPluginVisualScript/VisualScriptGraph/VisualScriptGraph.h
107 строк6 KB
Jan Krassnigg
Visual graph infrastructure cleanup (#1821)
19 фев 2026, 09:02
19 фев 2026, 09:027f7f12f
#pragma once

#include <EditorPluginVisualScript/VisualScriptGraph/VisualScriptNodeRegistry.h>
#include <ToolsFoundation/VisualGraph/VisualGraphObjectManager.h>

struct ezVisualScriptVariable;

/// Visual graph pin for visual script nodes.
///
/// Extends the base pin with visual scripting metadata including execution flow pins, data type information,
/// and support for type deduction. Pins can represent both execution flow and data connections.
class ezVisualScriptPin : public ezVisualGraphPin
{
  EZ_ADD_DYNAMIC_REFLECTION(ezVisualScriptPin, ezVisualGraphPin);

public:
  ezVisualScriptPin(Type type, ezStringView sName, const ezVisualScriptNodeRegistry::PinDesc& pinDesc, const ezDocumentObject* pObject, ezUInt32 uiDataPinIndex, ezUInt32 uiElementIndex);
  ~ezVisualScriptPin();

  EZ_ALWAYS_INLINE bool IsExecutionPin() const { return m_pDesc->IsExecutionPin(); }
  EZ_ALWAYS_INLINE bool IsDataPin() const { return m_pDesc->IsDataPin(); }

  EZ_ALWAYS_INLINE const ezRTTI* GetDataType() const { return m_pDesc->m_pDataType; }
  EZ_ALWAYS_INLINE ezVisualScriptDataType::Enum GetScriptDataType() const { return m_pDesc->m_ScriptDataType; }
  ezVisualScriptDataType::Enum GetResolvedScriptDataType() const;
  ezStringView GetDataTypeName() const;
  EZ_ALWAYS_INLINE ezUInt32 GetDataPinIndex() const { return m_uiDataPinIndex; }
  EZ_ALWAYS_INLINE ezUInt32 GetElementIndex() const { return m_uiElementIndex; }
  EZ_ALWAYS_INLINE bool IsRequired() const { return m_pDesc->m_bRequired; }
  EZ_ALWAYS_INLINE bool HasDynamicPinProperty() const { return m_pDesc->m_sDynamicPinProperty.IsEmpty() == false; }
  EZ_ALWAYS_INLINE bool SplitExecution() const { return m_pDesc->m_bSplitExecution; }
  EZ_ALWAYS_INLINE bool ReplaceWithArray() const { return m_pDesc->m_bReplaceWithArray; }
  EZ_ALWAYS_INLINE bool NeedsTypeDeduction() const { return m_pDesc->m_DeductTypeFunc != nullptr; }

  EZ_ALWAYS_INLINE const ezHashedString& GetDynamicPinProperty() const { return m_pDesc->m_sDynamicPinProperty; }
  EZ_ALWAYS_INLINE ezVisualScriptNodeRegistry::PinDesc::DeductTypeFunc GetDeductTypeFunc() const { return m_pDesc->m_DeductTypeFunc; }

  bool CanConvertTo(const ezVisualScriptPin& targetPin, bool bUseResolvedDataTypes = true) const;

private:
  const ezVisualScriptNodeRegistry::PinDesc* m_pDesc = nullptr;
  ezUInt32 m_uiDataPinIndex = 0;
  ezUInt32 m_uiElementIndex = 0;
};

/// Object manager for visual script graphs.
///
/// Manages visual script nodes and their connections, including both execution flow and data flow.
/// Handles complex features such as type deduction, dynamic pin creation, variable management,
/// and coroutine detection. Validates connections based on script data types and execution flow rules.
class ezVisualScriptNodeManager : public ezVisualGraphObjectManager
{
public:
  ezVisualScriptNodeManager();
  ~ezVisualScriptNodeManager();

  ezHashedString GetScriptBaseClass() const;
  bool IsFilteredByBaseClass(const ezRTTI* pNodeType, const ezVisualScriptNodeRegistry::NodeDesc& nodeDesc, const ezHashedString& sBaseClass, bool bLogWarning = false) const;

  ezVisualScriptDataType::Enum GetVariableType(ezTempHashedString sName) const;
  ezResult GetVariable(ezTempHashedString sName, ezVisualScriptVariable& out_variable) const;
  void GetAllVariables(ezDynamicArray<ezVisualScriptVariable>& out_variables) const;

  void GetInputExecutionPins(const ezDocumentObject* pObject, ezDynamicArray<const ezVisualScriptPin*>& out_pins) const;
  void GetOutputExecutionPins(const ezDocumentObject* pObject, ezDynamicArray<const ezVisualScriptPin*>& out_pins) const;

  void GetInputDataPins(const ezDocumentObject* pObject, ezDynamicArray<const ezVisualScriptPin*>& out_pins) const;
  void GetOutputDataPins(const ezDocumentObject* pObject, ezDynamicArray<const ezVisualScriptPin*>& out_pins) const;

  void GetEntryNodes(const ezDocumentObject* pObject, ezDynamicArray<const ezDocumentObject*>& out_entryNodes) const;

  static ezStringView GetNiceTypeName(const ezDocumentObject* pObject);
  static ezStringView GetNiceFunctionName(const ezDocumentObject* pObject);

  ezVisualScriptDataType::Enum GetDeductedType(const ezVisualScriptPin& pin) const;
  ezVisualScriptDataType::Enum GetDeductedType(const ezDocumentObject* pObject) const;

  bool IsCoroutine(const ezDocumentObject* pObject) const;
  bool IsLoop(const ezDocumentObject* pObject) const;

  ezEvent<const ezDocumentObject*> m_NodeChangedEvent;

private:
  virtual bool InternalIsNode(const ezDocumentObject* pObject) const override;
  virtual bool InternalIsDynamicPinProperty(const ezDocumentObject* pObject, const ezAbstractProperty* pProp) const override;
  virtual ezStatus InternalCanConnect(const ezVisualGraphPin& source, const ezVisualGraphPin& target, CanConnectResult& out_Result) const override;

  virtual void InternalCreatePins(const ezDocumentObject* pObject, NodeInternal& node) override;

  virtual void GetNodeCreationTemplates(ezDynamicArray<ezVisualGraphNodeDesc>& out_templates) const override;

  void NodeEventsHandler(const ezVisualGraphObjectManagerEvent& e);
  void PropertyEventsHandler(const ezDocumentObjectPropertyEvent& e);

  friend class ezVisualScriptPin;
  void RemoveDeductedPinType(const ezVisualScriptPin& pin);
  void DeductNodeTypeAndAllPinTypes(const ezDocumentObject* pObject, const ezVisualGraphPin* pDisconnectedPin = nullptr);
  void UpdateCoroutine(const ezDocumentObject* pTargetNode, const ezVisualGraphConnection& changedConnection, bool bIsAboutToDisconnect = false);
  bool IsConnectedToCoroutine(const ezDocumentObject* pEntryNode, const ezVisualGraphConnection& changedConnection, bool bIsAboutToDisconnect = false) const;

  ezHashTable<const ezDocumentObject*, ezEnum<ezVisualScriptDataType>> m_ObjectToDeductedType;
  ezHashTable<const ezVisualScriptPin*, ezEnum<ezVisualScriptDataType>> m_PinToDeductedType;
  ezHashSet<const ezDocumentObject*> m_CoroutineObjects;

  mutable ezDynamicArray<ezVisualGraphNodeProperty> m_PropertyValues;
  mutable ezDeque<ezString> m_VariableNodeTypeNames;
};