ITreeNode.h

Go to the documentation of this file.

#pragma once

 
#include "Types/Types.h"
#include <cstdint>
#include <functional>
#include <memory>
#include <vector>
 
namespace EmberCore {

class ITreeNode {
  public:
    enum class NodeType {
        Unknown,
        Action,      // Leaf nodes that perform actions
        Control,     // Control flow nodes (sequence, selector, parallel)
        Condition,   // Condition/decorator nodes
        Decorator,   // Modifier nodes that alter child behavior
        BehaviorTree // BehaviorTree definition node (visual wrapper)
    };

    enum class NodeStatus {
        Idle,    // Not yet executed
        Running, // Currently executing
        Success, // Execution completed successfully
        Failure  // Execution failed
    };

    enum class VisualState { Normal, Selected, Hovered, Highlighted };
 
  public:
    virtual ~ITreeNode() = default;
 
    // Core node properties
    virtual const String &GetName() const = 0;
    virtual NodeType GetType() const = 0;
    virtual NodeStatus GetStatus() const = 0;
    virtual size_t GetId() const = 0;
 
    // Tree structure
    virtual size_t GetChildCount() const = 0;
    virtual ITreeNode *GetChild(size_t index) const = 0;
    virtual ITreeNode *GetParent() const = 0;
    virtual bool HasChildren() const { return GetChildCount() > 0; }
 
    // Visual properties
    virtual const Point &GetPosition() const = 0;
    virtual void SetPosition(const Point &position) = 0;
    virtual VisualState GetVisualState() const = 0;
    virtual void SetVisualState(VisualState state) = 0;
 
    // Children visibility (for expand/collapse functionality)
    virtual bool AreChildrenVisible() const = 0;
    virtual void SetChildrenVisible(bool visible) = 0;
    virtual void ToggleChildrenVisibility() { SetChildrenVisible(!AreChildrenVisible()); }
 
    // Layout support
    virtual int GetChildrenWidth() const = 0;
    virtual void SetChildrenWidth(int width) = 0;
    virtual int CalculateSubtreeWidth(int node_width, int horizontal_spacing) const = 0;
 
    // Tree statistics
    virtual size_t GetDepth() const = 0;
    virtual size_t GetSubtreeNodeCount() const = 0;
 
    // SubTree/reference status
    virtual bool IsSubTreeReference() const { return false; }

    virtual bool IsUnimplementedReference() const { return false; }

    virtual String GetSubTreeReference() const { return ""; }
 
    // Utility functions for display
    virtual String GetTypeString() const {
        switch (GetType()) {
        case NodeType::Action:
            return "Action";
        case NodeType::Control:
            return "Control";
        case NodeType::Condition:
            return "Condition";
        case NodeType::Decorator:
            return "Decorator";
        case NodeType::BehaviorTree:
            return "BehaviorTree";
        default:
            return "Unknown";
        }
    }
 
    virtual String GetStatusString() const {
        switch (GetStatus()) {
        case NodeStatus::Idle:
            return "Idle";
        case NodeStatus::Running:
            return "Running";
        case NodeStatus::Success:
            return "Success";
        case NodeStatus::Failure:
            return "Failure";
        default:
            return "Unknown";
        }
    }
 
    // Visitor pattern support for tree traversal
    virtual void Accept(std::function<void(ITreeNode *)> visitor) = 0;
    virtual void Accept(std::function<void(const ITreeNode *)> visitor) const = 0;
};
 
} // namespace EmberCore