HummingbirdBaseComponent.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 "cohtml/View.h"

#include "HummingbirdMeshData.h"
#include "HummingbirdSystem.h"
#include "HummingbirdEventHelpers.h"
#include "HummingbirdViewListener.h"
#include "HummingbirdRenderWrapper.h"
#include "HummingbirdAudioWrapper.h"
#include "HummingbirdDataBinding.h"
#include "HummingbirdBaseComponent.generated.h"

namespace cohtml
{
class SystemRenderer;
}

class FHummingbirdGesturePolicy;

UCLASS(BlueprintType)
class HUMMINGBIRDPLUGIN_API UHummingbirdBaseComponent : public UActorComponent
{
    GENERATED_UCLASS_BODY()
public:
    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")
    virtual void Resize(/*uint32*/ int32 width, /*uint32*/ int32 height);

    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();

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

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

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

    UFUNCTION(BlueprintCallable, Category = "View")
    void EnableDelayedUpdate(bool bEnabled);

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

    UFUNCTION(BlueprintCallable, Category = "ViewScripting")
    void TriggerJSEvent(const FString& name, UHummingbirdJSEvent* eventData) const;

    UFUNCTION(BlueprintCallable, Category = "ViewScripting")
    void CreateDataModelFromObject(const FString& Name, UObject* Model);

    UFUNCTION(BlueprintCallable, CustomThunk, meta = (CustomStructureParam = "Arg"), Category = "ViewScripting")
    void CreateDataModelFromStruct(const FString& Name, const UStructProperty* Arg);

    UFUNCTION(BlueprintCallable, Category = "ViewScripting")
    void UpdateWholeDataModelFromObject(UObject* Model) const;

    UFUNCTION(BlueprintCallable, CustomThunk, meta = (CustomStructureParam = "Struct"), Category = "ViewScripting")
    void UpdateWholeDataModelFromStruct(const UStructProperty* Struct) const;

    UFUNCTION(BlueprintCallable, Category = "ViewScripting")
    void SynchronizeModels() const;

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

    UPROPERTY(BlueprintReadOnly, Category = "View")
    UTextureRenderTarget2D* Texture;

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

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

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

    static void CreateSystemIfNecessary(UWorld* World);
    static class AHummingbirdSystem* GetSystemActor(UWorld* World);

    virtual ~UHummingbirdBaseComponent();
    virtual void InitializeComponent() override;
    virtual void BeginDestroy() override;
    virtual bool IsReadyForFinishDestroy() override;
    virtual void FinishDestroy() override;

    virtual void TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override;

    bool EnsureMeshData();
    TArray<FHummingbirdMeshData> MeshData;

    typedef TArray<TWeakObjectPtr<UHummingbirdBaseComponent>> WeakHummingbirdComponentsArray;
    static WeakHummingbirdComponentsArray::TIterator GetUHummingbirdBaseComponentIterator(UWorld* world);

    cohtml::View* GetView() const;
    cohtml::ViewRenderer* GetViewRenderer() const;
    FHummingbirdGesturePolicy* GetGesturePolicy();

protected:
    void CreateView(const cohtml::ViewSettings& info, const FString& url);

    virtual void SendRenderDynamicData_Concurrent() override;
    virtual bool RequiresGameThreadEndOfFrameUpdates() const override { return true; }

private:
    friend class THummingbirdViewListener<UHummingbirdBaseComponent>;

    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<UHummingbirdBaseComponent> AudioWrapper;

    void SetReadyForBindings();

    FCaretRect CaretRect;
    TUniquePtr<THummingbirdViewListener<UHummingbirdBaseComponent>> Listener;
    TUniquePtr<FHummingbirdRenderWrapper> RenderWrapper;

    // Custom deleter function is used so we can use a forward declaration of GesturePolicy
    struct GesturePolicyDeleter
    {
        void operator()(FHummingbirdGesturePolicy* Ptr) const;
    };
    TUniquePtr<FHummingbirdGesturePolicy, GesturePolicyDeleter> GesturePolicy;

    AHummingbirdSystem* SystemActor;
    cohtml::SystemRenderer* SystemRenderer;

    bool bIsReadyForBindings;

    bool bIsLoadingMeshData;
    bool bHasMeshData;

    void LoadMeshData(const TArray<TWeakObjectPtr<UStaticMeshComponent>>& Meshes);

    unsigned PendingLayout;

public:
#if defined(HUMMINGBIRD_UE4_418_SUPPORT)
    DECLARE_FUNCTION(execCreateDataModelFromStruct)
    {
        if (!bIsReadyForBindings)
        {
            return;
        }
        P_GET_PROPERTY(UStrProperty, Name);

        Stack.StepCompiledIn<UStructProperty>(NULL);
        void* ArgAddress = Stack.MostRecentPropertyAddress;
        UStructProperty* Prop = Cast<UStructProperty>(Stack.MostRecentProperty);

        if (Prop)
        {
            HummingbirdDataBindingHelpers::CreateModel(GetView(), Name, ArgAddress, Prop->Struct);
        }
        P_FINISH;
    }

    DECLARE_FUNCTION(execUpdateWholeDataModelFromStruct)
    {
        if (!bIsReadyForBindings)
        {
            return;
        }

        Stack.StepCompiledIn<UStructProperty>(NULL);
        void* ArgAddress = Stack.MostRecentPropertyAddress;
        UStructProperty* Prop = Cast<UStructProperty>(Stack.MostRecentProperty);
        HummingbirdDataBindingHelpers::UpdateWholeModel(GetView(), ArgAddress, Prop->Struct);
        P_FINISH;
    }
#else
    //declared here and defined in the cpp file
    DECLARE_FUNCTION(execCreateDataModelFromStruct);
    DECLARE_FUNCTION(execUpdateWholeDataModelFromStruct);
#endif
};