SViewport.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Input/CursorReply.h"
#include "Input/Reply.h"
#include "Input/NavigationReply.h"
#include "Input/PopupMethodReply.h"
#include "Widgets/SWidget.h"
#include "Widgets/SCompoundWidget.h"
#include "Rendering/RenderingCommon.h"
#include "Widgets/SWindow.h"
 
class FActiveTimerHandle;
class FPaintArgs;
class FSlateWindowElementList;
class ICustomHitTestPath;
 
 
template <>
struct TWidgetTypeTraits<class SViewport>
{
    static constexpr bool SupportsInvalidation() { return true; }
};
 
class SViewport
    : public SCompoundWidget
{
public:
    
    SLATE_BEGIN_ARGS( SViewport )
        : _Content()
        , _ShowEffectWhenDisabled(true)
        , _RenderDirectlyToWindow(false)
        , _EnableGammaCorrection(true)
        , _ReverseGammaCorrection(false)
        , _EnableBlending(false)
        , _EnableStereoRendering(false)
        , _PreMultipliedAlpha(true)
        , _IgnoreTextureAlpha(true)
        , _ViewportSize(GetDefaultViewportSize())
    {
        _Clipping = EWidgetClipping::ClipToBoundsAlways;
    }
 
        SLATE_DEFAULT_SLOT( FArguments, Content )
 
        
        SLATE_ATTRIBUTE( bool, ShowEffectWhenDisabled )
 
        
        SLATE_ARGUMENT( bool, RenderDirectlyToWindow )
 
        
        SLATE_ARGUMENT( bool, EnableGammaCorrection )
 
        
        SLATE_ARGUMENT( bool, ReverseGammaCorrection )
 
        
        SLATE_ARGUMENT( bool, EnableBlending )
 
        
        SLATE_ARGUMENT(bool, EnableStereoRendering )
 
        
        SLATE_ARGUMENT( bool, PreMultipliedAlpha )
 
        
        SLATE_ARGUMENT( bool, IgnoreTextureAlpha )
 
        
        SLATE_ARGUMENT(TSharedPtr<ISlateViewport>, ViewportInterface)
 
        
        SLATE_ATTRIBUTE(FVector2D, ViewportSize);
 
        SLATE_API static UE::Slate::FDeprecateVector2DResult GetDefaultViewportSize();
 
    SLATE_END_ARGS()
 
    SLATE_API SViewport();
    SLATE_API virtual ~SViewport();
 
    SLATE_API void Construct(const FArguments& InArgs);
 
public:
 
    virtual bool SupportsKeyboardFocus() const override { return true; }
 
    virtual FVector2D ComputeDesiredSize(float) const override
    {
        return ViewportSize.Get();
    }
 
    SLATE_API void SetViewportInterface( TSharedRef<ISlateViewport> InViewportInterface );
 
    TWeakPtr<ISlateViewport> GetViewportInterface()
    {
        return ViewportInterface;
    }
 
    SLATE_API void SetContent( TSharedPtr<SWidget> InContent );
 
    SLATE_API void SetCustomHitTestPath( TSharedPtr<ICustomHitTestPath> CustomHitTestPath );
 
    SLATE_API TSharedPtr<ICustomHitTestPath> GetCustomHitTestPath();
 
    const TSharedPtr<SWidget> GetContent() const { return ChildSlot.GetWidget(); }
 
    SLATE_API void OnWindowClosed( const TSharedRef<SWindow>& InWindowBeingClosed );
 
    SLATE_API FReply OnViewportActivated(const FWindowActivateEvent& InActivateEvent);
 
    SLATE_API void OnViewportDeactivated(const FWindowActivateEvent& InActivateEvent);
 
    bool ShouldRenderDirectly() const { return bRenderDirectlyToWindow; }
 
    bool IsStereoRenderingAllowed() const { return bEnableStereoRendering; }
 
    SLATE_API void SetRenderDirectlyToWindow( const bool bInRenderDirectlyToWindow );
 
    SLATE_API void SetIgnoreTextureAlpha(const bool bInIgnoreTextureAlpha);
 
    bool GetIgnoreTextureAlpha(void) const
    {
        return bIgnoreTextureAlpha;
    }
 
    void EnableStereoRendering( const bool bInEnableStereoRendering )
    {
        bEnableStereoRendering = bInEnableStereoRendering;
    }
 
    SLATE_API void SetActive(bool bActive);
 
public:
 
    // SWidget interface
 
    SLATE_API virtual int32 OnPaint( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled ) const override;
    SLATE_API virtual void Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) override;
    SLATE_API virtual FReply OnTouchStarted( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent ) override;
    SLATE_API virtual FReply OnTouchMoved( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent ) override;
    SLATE_API virtual FReply OnTouchEnded( const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent ) override;
    SLATE_API virtual FReply OnTouchForceChanged(const FGeometry& MyGeometry, const FPointerEvent& TouchEvent) override;
    SLATE_API virtual FReply OnTouchFirstMove(const FGeometry& MyGeometry, const FPointerEvent& TouchEvent) override;
    SLATE_API virtual FReply OnTouchGesture( const FGeometry& MyGeometry, const FPointerEvent& GestureEvent ) override;
    SLATE_API virtual FCursorReply OnCursorQuery( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent ) const override;
    SLATE_API virtual TOptional<TSharedRef<SWidget>> OnMapCursor(const FCursorReply& CursorReply) const override;
    SLATE_API virtual FReply OnMouseButtonDown( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonUp( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual void OnMouseEnter( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual void OnMouseLeave( const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseMove( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseWheel( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonDoubleClick( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnKeyDown( const FGeometry& MyGeometry, const FKeyEvent& KeyEvent ) override;
    SLATE_API virtual FReply OnKeyUp( const FGeometry& MyGeometry, const FKeyEvent& KeyEvent ) override;
    SLATE_API virtual FReply OnAnalogValueChanged( const FGeometry& MyGeometry, const FAnalogInputEvent& InAnalogInputEvent ) override;
    SLATE_API virtual FReply OnKeyChar( const FGeometry& MyGeometry, const FCharacterEvent& CharacterEvent ) override;
    SLATE_API virtual FReply OnFocusReceived( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual void OnFocusLost( const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual FReply OnMotionDetected( const FGeometry& MyGeometry, const FMotionEvent& InMotionEvent ) override;
    SLATE_API virtual TOptional<bool> OnQueryShowFocus( const EFocusCause InFocusCause ) const override;
    SLATE_API virtual FPopupMethodReply OnQueryPopupMethod() const override;
    SLATE_API virtual void OnFinishedPointerInput() override;
    SLATE_API virtual void OnArrangeChildren( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren ) const override;
    SLATE_API virtual TOptional<FVirtualPointerPosition> TranslateMouseCoordinateForCustomHitTestChild(const SWidget& ChildWidget, const FGeometry& MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const override;
    SLATE_API virtual FNavigationReply OnNavigation( const FGeometry& MyGeometry, const FNavigationEvent& InNavigationEvent ) override;
 
private:
    // Viewports shouldn't show focus
    virtual const FSlateBrush* GetFocusBrush() const override
    {
        return nullptr;
    }
 
protected:
    SLATE_API EActiveTimerReturnType EnsureTick(double InCurrentTime, float InDeltaTime);
 
    TWeakPtr<ISlateViewport> ViewportInterface;
    
private:
 
    TWeakPtr<SWindow> CachedParentWindow;
 
    TWeakPtr<FActiveTimerHandle> ActiveTimerHandle;
 
    TSlateAttribute<bool, EInvalidateWidgetReason::Paint> ShowDisabledEffect;
 
    TSlateAttribute<FVector2D, EInvalidateWidgetReason::Layout> ViewportSize;
 
    TSharedPtr<ICustomHitTestPath> CustomHitTestPath;
 
    bool bRenderDirectlyToWindow;
 
    bool bEnableGammaCorrection;
 
    bool bReverseGammaCorrection;
 
    bool bEnableBlending;
 
    bool bEnableStereoRendering;
 
    bool bIgnoreTextureAlpha;
 
    bool bPreMultipliedAlpha;
};