HummingbirdWidget.h

/*
This file is part of Hummingbird, modern user interface library for
games. Release $RELEASE$. Build $VERSION$ for $LICENSEE$.

Copyright (c) 2012-2018 Coherent Labs AD and/or its licensors. All
rights reserved in all media.

The coded instructions, statements, computer programs, and/or related
material (collectively the "Data") in these files contain confidential
and unpublished information proprietary Coherent Labs and/or its
licensors, which is protected by United States of America federal
copyright law and by international treaties.

This software or source code is supplied under the terms of a license
agreement and nondisclosure agreement with Coherent Labs Limited and may
not be copied, disclosed, or exploited except in accordance with the
terms of that agreement. The Data may not be disclosed or distributed to
third parties, in whole or in part, without the prior written consent of
Coherent Labs Limited.

COHERENT LABS MAKES NO REPRESENTATION ABOUT THE SUITABILITY OF THIS
SOURCE CODE FOR ANY PURPOSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER, ITS AFFILIATES,
PARENT COMPANIES, LICENSORS, SUPPLIERS, OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OR PERFORMANCE OF THIS SOFTWARE OR SOURCE CODE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once

#include <Sound/SoundAttenuation.h>
#include "Runtime/UMG/Public/Components/Widget.h"
#include "SHummingbirdWidget.h"
#include "HummingbirdEventHelpers.h"
#include "HummingbirdViewListener.h"
#include "HummingbirdAudioWrapper.h"

#include "HummingbirdWidget.generated.h"

namespace cohtml
{
class View;
}

UCLASS(meta=(DisplayName = "Hummingbird Widget"))
class HUMMINGBIRDPLUGIN_API UHummingbirdWidget : public UWidget
{
    GENERATED_UCLASS_BODY()

public:
    virtual ~UHummingbirdWidget();
    virtual TSharedRef<SWidget> RebuildWidget() override;
    virtual void SynchronizeProperties() override;
#if WITH_EDITOR
    virtual const FText GetPaletteCategory() override;
#endif

protected:
    TSharedPtr<SHummingbirdWidget> CoherentWidget;

private:
    void OnViewCreated(cohtml::View* View);

    friend class THummingbirdViewListener<UHummingbirdWidget>;

    // During destruction we will lose the ref to the slate widget
    // which means that can't access its view (which will be in the process of destruction, yet still alive).
    // We need the view so that we can replay any events left over in async mode so store it here.
    // In other words - this is only used during destruction and shouldn't even be used directly, use GetView() instead
    cohtml::View* CachedView;

public:
    UPROPERTY(BlueprintReadWrite, Category = "View")
    AActor* Owner;

    // BASE COMPONENT COPY START

    UFUNCTION(BlueprintCallable, Category = "Audio")
    void SetSoundAttenuation(const FSoundAttenuationSettings& Settings);

    UPROPERTY(BlueprintAssignable)
    FHBReadyForBindingsSignature ReadyForBindings;

    UPROPERTY(BlueprintAssignable)
    FHBBindingsReleasedSignature BindingsReleased;

    UPROPERTY(BlueprintAssignable)
    FHBScriptingReady HBScriptingReady;

    UFUNCTION(BlueprintCallable, Category = "View")
    bool IsReadyToCreateView() const;

    UFUNCTION(BlueprintCallable, Category = "View")
    bool IsReadyForBindings() const;

    UFUNCTION(BlueprintCallable, Category = "View")
    bool HasRequestedView() const;

    UFUNCTION(BlueprintCallable, Category = "View")
    void ShowPaintRects(bool show);

    UFUNCTION(BlueprintCallable, Category = "View")
    void Load(const FString& path);

    UFUNCTION(BlueprintCallable, Category = "View")
    void Reload();

    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View", DisplayName = "Enable Complex CSS Selector Support")
    bool bEnableComplexCSSSupport;

    UFUNCTION(BlueprintCallable, Category = "View")
    UTextureRenderTarget2D* GetRenderTexture() const;

    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View", AdvancedDisplay)
    TEnumAsByte<enum TextureFilter> Filter;

    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View")
    bool bReceiveInput;

    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View")
    bool bGammaCorrectedMaterial;

    UFUNCTION(BlueprintCallable, Category = "ViewScripting")
    UHummingbirdJSEvent* CreateJSEvent();

    UFUNCTION(BlueprintCallable, Category = "ViewScripting")
    void TriggerJSEvent(const FString& name, UHummingbirdJSEvent* eventData) const;
    
    inline cohtml::View* GetView() const
    {
        if (CoherentWidget.IsValid())
        {
            return CoherentWidget->GetView();
        }
        return CachedView;
    }

    virtual void BeginDestroy() override;
    virtual void ReleaseSlateResources(bool bReleaseChildren) override;

private:
    void OnAudioStreamCreated(int Id, int BitDepth, int Channels, float SamplingRate);
    void OnAudioStreamClosed(int Id);
    void OnAudioStreamPlay(int Id);
    void OnAudioStreamPause(int Id);
    void OnAudioDataReceived(int Id, int Samples, float** Pcm, int Channels);
    void OnAudioStreamEnded(int Id);
    void OnAudioStreamVolumeChanged(int Id, float Volume);

    THummingbirdAudioWrapper<AActor> AudioWrapper;

    void SetReadyForBindings();

    bool NeedsViewRecreation() const;

    TUniquePtr<THummingbirdViewListener<UHummingbirdWidget>> Listener;
    bool bIsReadyForBindings;
    cohtml::ViewSettings LastSavedViewSettings;

    // BASE COMPONENT COPY END

    // COMPONENT COPY BEGIN. DON'T COPY WIDTH AND HEIGHT
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View")
    FString URL;

    // COMPONENT COPY END
};