AdvancedWidgetComponent.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Components/WidgetComponent.h"
#include "Gameplay/ReactsToMatchEvents.h"
#include "AdvancedWidgetComponent.generated.h"
 
class UAdvancedUserWidget;
 
UENUM(BlueprintType)
enum class EClampType : uint8
{
    SCREEN = 0,
    CENTER = 1,
};
 
UCLASS(Blueprintable, ClassGroup = "UserInterface", hidecategories = (Object, Activation, "Components|Activation", Sockets, Base, Lighting, LOD, Mesh), editinlinenew, meta = (BlueprintSpawnableComponent))
class PROJECTX_API UAdvancedWidgetComponent : public UWidgetComponent, public IReactsToMatchEvents
{
    GENERATED_UCLASS_BODY()
    
public:
    virtual void BeginPlay() override;
    virtual void EndPlay(const EEndPlayReason::Type Reason) override;
    UFUNCTION()
    virtual void MenuToggled(UAdvancedUserWidget* OpenedWidget, bool bToggle);
 
    void ManageVisibility();
    bool ShouldClampToScreen() const { return bClampToScreen; }
    bool IsWidgetVisible() const override;
    virtual void InitWidget() override;
    virtual void ReleaseResources() override;
 
    virtual void MatchEnded() override;
 
    virtual void ModifyScreenPosition(FVector2D& ScreenPosition);
    
    UFUNCTION(BlueprintCallable)
    float GetClampRadius() const {return ClampRadius;}
    UFUNCTION(BlueprintCallable)
    EClampType GetClampType() const { return ClampType; }
    UFUNCTION(BlueprintCallable, Category = UserInterface)
    virtual void SetScreenPositionOverride(const FVector2D& NewScreenPosition, float OverrideStrength = -1.f);
 
    UFUNCTION(BlueprintCallable)
    bool IsUsingScreenPositionOverride() const { return ScreenPositionOverrideStrength > 0.f; }
 
    UFUNCTION(BlueprintImplementableEvent)
    void OnWidgetClamped(bool bIsClamped);
 
    UFUNCTION(BlueprintCallable, Category= UserInterfaceCommand, meta=(WorldContext="WorldContextObject", DeterminesOutputType="WidgetComponentClass", DynamicOutputParam="OutWidgetComponents"))
    static void GetAllWidgetComponentsOfClass(const UObject* WorldContextObject, TSubclassOf<UAdvancedWidgetComponent> WidgetComponentClass, TArray<UAdvancedWidgetComponent*>& OutWidgetComponents);
    UFUNCTION(BlueprintCallable, meta=(DeterminesOutputType="WidgetComponentClass", DynamicOutputParam="WidgetComponent"))
    static void CreateWidgetComponent(AActor* Owner, const FTransform& Transform, TSubclassOf<UWidgetComponent> WidgetComponentClass, UWidgetComponent*& WidgetComponent);
 
protected:
    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
 
protected:
#if !UE_SERVER
    class UGameViewportClient* OwningViewport = NULL;
#endif // !UE_SERVER
 
    /* Clamp to screen. */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = Layers)
    bool bClampToScreen = false;
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = Layers)
    EClampType ClampType = EClampType::SCREEN;
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = Layers)
    float ClampRadius = 0.f;
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = Layers)
    bool bHideWhenDeployScreenActive = false;
    /* Will activate pooling for this user widget. You will want to use PoolConstruct on the widget to ensure it runs init code each time it's instanced */
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = Layers)
    bool bPoolUserWidget = false;
    
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite)
    float MaxDesiredDrawDistance = 100000.0f;
 
    /* Should be auto destroyed on match end or not. */
    UPROPERTY(EditDefaultsOnly, Category = Layers)
    bool bAutoCleanup = true;
 
    float ScreenPositionOverrideStrength = 0.f;
    FVector2D ScreenPositionOverride = FVector2D(0, 0);
    bool bDeployScreenActive = false;
};