ArticyPins.h

//  
// Copyright (c) 2023 articy Software GmbH & Co. KG. All rights reserved.  
//
 
#pragma once
 
#include "ArticyObject.h"
#include "ArticyBaseTypes.h"
#include "ArticyPausableType.h"
#include "Interfaces/ArticyFlowObject.h"
#include "Interfaces/ArticyConditionProvider.h"
#include "Interfaces/ArticyInstructionProvider.h"
 
#include "ArticyPins.generated.h"
 
class UArticyOutgoingConnection;
UCLASS(BlueprintType)
class ARTICYRUNTIME_API UArticyFlowPin : public UArticyPrimitive, public IArticyFlowObject
{
    GENERATED_BODY()
 
public:
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "Articy")
    FString Text = "";

    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "Articy")
    FArticyId Owner;

    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "Articy")
    TArray<UArticyOutgoingConnection*> Connections;
 
    void InitFromJson(TSharedPtr<FJsonValue> Json) override;
 
    UFUNCTION(BlueprintCallable, Category = "Articy")
    UArticyObject* GetOwner();
 
    //---------------------------------------------------------------------------//
 
    EArticyPausableType GetType() override { return EArticyPausableType::Pin; }
 
    //stub implementation
    void Explore(UArticyFlowPlayer* Player, TArray<FArticyBranch>& OutBranches, const uint32& Depth) override { ensure(false); }
};

UCLASS(BlueprintType)
class ARTICYRUNTIME_API UArticyInputPin : public UArticyFlowPin, public IArticyConditionProvider
{
    GENERATED_BODY()
 
public:
 
    EArticyPausableType GetType() override { return UArticyFlowPin::GetType(); }
 
    //---------------------------------------------------------------------------//
 
    bool Evaluate(class UArticyGlobalVariables* GV = nullptr, class UObject* MethodProvider = nullptr) override;
 
    void Explore(UArticyFlowPlayer* Player, TArray<FArticyBranch>& OutBranches, const uint32& Depth) override;
};

UCLASS(BlueprintType)
class ARTICYRUNTIME_API UArticyOutputPin : public UArticyFlowPin, public IArticyInstructionProvider
{
    GENERATED_BODY()
 
public:
 
    EArticyPausableType GetType() override { return UArticyFlowPin::GetType(); }
 
    //---------------------------------------------------------------------------//
 
    void Execute(class UArticyGlobalVariables* GV = nullptr, class UObject* MethodProvider = nullptr) override;
 
    void Explore(UArticyFlowPlayer* Player, TArray<FArticyBranch>& OutBranches, const uint32& Depth) override;
};