LayoutGroupComponent.h

Go to the documentation of this file.

// Copyright 2024 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "LayoutComponent.h"
#include "Logics/ComponentLogic.h"
#include "LayoutGroupComponent.generated.h"
 
class STouchInterfaceRuntime;

UCLASS()
class TOUCHINTERFACE_API ULayoutGroupComponent : public ULayoutComponent
{
    GENERATED_BODY()
 
public:
    ULayoutGroupComponent();
 
    virtual void BeginDestroy() override;
 
    virtual TSharedRef<SLayoutComponent> TakeWidget(SConstraintCanvas::FSlot* WidgetSlot, TSharedPtr<STouchInterface> LayoutWidget, ULocalPlayer* LocalPlayer, TSharedPtr<SLayoutComponent> InParent = nullptr) override;
 
    virtual TArray<ULayoutComponent*> GetChildren();
    
 
#if WITH_EDITOR
    virtual void OnBeginEditByEditor() override;
    virtual void OnEndEditByEditor() override;
 
    virtual TSharedRef<SLayoutComponent> TakeEditorWidget(SConstraintCanvas::FSlot* WidgetSlot, TSharedPtr<STouchInterface> LayoutWidget, TSharedPtr<SLayoutComponent> InParent = nullptr) override;
 
    void CheckChildrenValidity();
#endif
    
 
    //TODO: Maybe remove this function and add create child function in function library
    UFUNCTION(Category="Group Input Component", BlueprintCallable)
    virtual ULayoutComponent* AddChild(const FName DesiredName, const FVector2D ChildPosition, FVector2D ChildSize, const TSubclassOf<UComponentLogic> ChildLogicClass);

    UFUNCTION(Category="Group Input Component", BlueprintCallable)
    virtual void AddChildByRef(ULayoutComponent* LayoutComponentInstance);
    
    // Remove component from group
    UFUNCTION(Category="Group Input Component", BlueprintCallable)
    virtual void RemoveComponentFromGroup(ULayoutComponent* Component);
    
    // Remove component from group
    UFUNCTION(Category="Group Input Component", BlueprintCallable)
    virtual void RemoveComponentByName(const FName ComponentName);
    
    
    // Displays all components in group
    UFUNCTION(Category="Group Input Component|Visibility", BlueprintCallable)
    virtual void ShowAllComponentsInGroup();
    
    // Hide all components in group
    UFUNCTION(Category="Group Input Component|Visibility", BlueprintCallable)
    virtual void HideAllComponentsInGroup();
    
    // Displays all components except the named one
    UFUNCTION(Category="Group Input Component|Visibility", BlueprintCallable)
    virtual void ShowAllExcept(const FName Name);
    
    // Hide all components except the named one
    UFUNCTION(Category="Group Input Component|Visibility", BlueprintCallable)
    virtual void HideAllExcept(const FName Name);
    
    // Displays all components except the named one
    UFUNCTION(Category="Group Input Component|Visibility", BlueprintCallable)
    virtual void ShowAllExceptNamedOnes(const TArray<FName> Names);
    
    // Hide all components except the named one
    UFUNCTION(Category="Group Input Component|Visibility", BlueprintCallable)
    virtual void HideAllExceptNamedOnes(const TArray<FName> Names);
 
    
    UFUNCTION(Category="Group Input Component|Utility", BlueprintCallable)
    virtual bool ContainComponent(const ULayoutComponent* Component);
    
    UFUNCTION(Category="Group Input Component|Utility", BlueprintCallable)
    virtual bool ContainComponentByName(const FName ComponentName) const;
    
    UFUNCTION(Category="Group Input Component|Utility", BlueprintCallable)
    virtual bool GetAllComponentsInGroup(TArray<ULayoutComponent*>& Components);
    
    UFUNCTION(Category="Group Input Component|Utility", BlueprintCallable)
    virtual ULayoutComponent* GetComponentByName(const FName Name) const;
    
    UFUNCTION(Category="Group Input Component|Utility", BlueprintCallable)
    virtual bool GetComponentsByLogicClass(const TSubclassOf<UComponentLogic> Class, const bool bIncludeInherited, TArray<ULayoutComponent*>& Components);
    
    // Returns index of component
    UFUNCTION(Category="Group Input Component|Utility", BlueprintCallable, BlueprintPure)
    int32 GetIndexOfComponent(ULayoutComponent* Component);
    
    UFUNCTION(Category="Group Input Component|Utility", BlueprintCallable)
    virtual bool GetAllComponentNameInGroup(TArray<FName>& Names);
 
    
    //TODO: Use Instanced meta (deep copy instead of shallow copy)
    UPROPERTY()
    TArray<TObjectPtr<ULayoutComponent>> Children;
 
    //TODO: Make custom detail because we need to hide some properties if this bool == false
    UPROPERTY(Category="Group", EditAnywhere, BlueprintReadOnly)
    uint8 bSupportInput:1;
};