CoherentBaseComponent.h

/*
This file is part of Coherent UI, modern user interface library for
games.

Copyright (c) 2012-2014 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 "CoherentUIViewListener.h"
#include "CoherentMediaRequestHandler.h"
#include "CoherentUIJSEvent.h"
#include "CoherentUIJSPayload.h"

#include "CoherentBaseComponent.generated.h"

USTRUCT()
struct FCoherentComponentTickFunction : public FTickFunction
{
    GENERATED_USTRUCT_BODY()

    class UCoherentBaseComponent* Target;

    virtual void ExecuteTick(float DeltaTime, enum ELevelTick TickType, ENamedThreads::Type CurrentThread, const FGraphEventRef& MyCompletionGraphEvent) override;
    virtual FString DiagnosticMessage();
};

DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FUIReadyForBindingsSignature, int32, frameId, const FString&, Path, bool, isMainFrame);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FUIBindingsReleasedSignature, int32, frameId, const FString&, validatedPath, bool, isMainFrame);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams(FUIFinishLoadSignature, int32, frameId, const FString&, validatedPath, bool, isMainFrame, int32, statusCode);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams(FUIFailLoad, int32, frameId, const FString&, validatedPath, bool, isMainFrame, const FString&, error);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FUIOnNavigate, const FString&, url);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FUIScriptMessage, const FString&, message, const FString&, sourceId, int32, line);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FUICursorChanged, int32, cursorId);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams(FUIJavaScriptMesssage, const FString&, message, const FString&, defaultPrompt, const FString&, frameURL, int32, type);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FUIOnError, const FString&, error);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FUIOnJavaScriptEvent, UCoherentUIJSPayload*, payload);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FUIScriptingReady);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FUIOnViewCreated);

UCLASS(BlueprintType)
class COHERENTUIPLUGIN_API UCoherentBaseComponent : public UActorComponent, public FCoherentUIViewListener
{
    GENERATED_UCLASS_BODY()
public:
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View")
    FString URL;

    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View", meta = (ClampMin = "0", UIMin = "0", UIMax = "4096"))
    int32 Width;

    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View", meta = (ClampMin = "0", UIMin = "0", UIMax = "4096"))
    int32 Height;

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

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

    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "View", meta = (ClampMin = "1", UIMin = "1", UIMax = "120"))
    int32 MaxFPS;

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

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

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

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

    UPROPERTY(BlueprintAssignable)
    FUIReadyForBindingsSignature ReadyForBindings;
    
    UPROPERTY(BlueprintAssignable)
    FUIBindingsReleasedSignature BindingsReleased;
    
    UPROPERTY(BlueprintAssignable)
    FUIFinishLoadSignature FinishLoad;
    
    UPROPERTY(BlueprintAssignable)
    FUIFailLoad FailLoad;

    UPROPERTY(BlueprintAssignable)
    FUIOnNavigate OnNavigate;

    UPROPERTY(BlueprintAssignable)
    FUIScriptMessage ScriptMessage;

    UPROPERTY(BlueprintAssignable)
    FUICursorChanged CursorChanged;

    UPROPERTY(BlueprintAssignable)
    FUIJavaScriptMesssage JavaScriptMessage;

    UPROPERTY(BlueprintAssignable)
    FUIOnError ErrorOccured;

    UPROPERTY(BlueprintAssignable)
    FUIOnJavaScriptEvent JavaScriptEvent;

    UPROPERTY(BlueprintAssignable)
    FUIScriptingReady UIScriptingReady;

    UPROPERTY(BlueprintAssignable)
    FUIOnViewCreated UIOnViewCreated;

    UFUNCTION(BlueprintCallable, Category = "View")
    UCoherentMediaRequestHandler* GetMediaRequestHandler();

    UFUNCTION(BlueprintCallable, Category = "View")
    void Resize(int32 resizeWidth, int32 resizeHeight);

    UFUNCTION(BlueprintCallable, Category = "View")
    void IssueMouseOnUIQuery(float normX, float normY);

    UFUNCTION(BlueprintCallable, Category = "View")
    bool HasMouseQueryFinished();

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

    UFUNCTION(BlueprintCallable, Category = "View")
    bool IsMouseOnView();

    UFUNCTION(BlueprintCallable, Category = "View")
    void SetClickThroughAlphaThreshold(float threshold);

    UFUNCTION(BlueprintCallable, Category = "View")
    float GetClickThroughAlphaThreshold() const;

    UFUNCTION(BlueprintCallable, Category = "View")
    void SetTargetFramerate(int32 target);
    
    UFUNCTION(BlueprintCallable, Category = "View")
    int32 GetTargetFramerate() const;

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

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

    UFUNCTION(BlueprintCallable, Category = "View")
    void Redraw() const;

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

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

    UFUNCTION(BlueprintCallable, Category = "View")
    FString GetCurentViewPath() const;
    
    UFUNCTION(BlueprintCallable, Category = "View")
    FString GetLastRequestedPath() const;
    
    UFUNCTION(BlueprintCallable, Category = "View")
    FString GetLastLoadedPath() const;
    
    UFUNCTION(BlueprintCallable, Category = "View")
    FString GetLastFailedPath() const;

    UFUNCTION(BlueprintCallable, Category = "View")
    UTexture2D* GetTexture() const;

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

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

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

    UFUNCTION(BlueprintCallable, Category = "ViewScripting")
    bool  IsReadyForScripting() const;

public:
    virtual void InitializeComponent();
    virtual void TickCustom(FCoherentComponentTickFunction* function);

    FCoherentComponentTickFunction PostPhysicsComponentTick;

    void RegisterTickFunctions(bool bRegister);

    virtual void OnRegister() override;
    virtual void OnUnregister() override;
    virtual void OnComponentDestroyed() override;

    virtual void BeginDestroy() override;
    virtual bool IsReadyForFinishDestroy() override;

public:
    virtual void OnViewCreated(Coherent::UI::View* View) override;
    void OnScriptingReady();
    virtual void OnReadyForBindings(int frameId,
        const wchar_t* path,
        bool isMainFrame) override;
    virtual void OnFinishLoad(int frameId,
        const wchar_t* validatedPath,
        bool isMainFrame,
        int statusCode,
        Coherent::UI::HTTPHeader* headers,
        unsigned headersCount) override;
    virtual void OnFailLoad(int frameId,
        const wchar_t* validatedPath,
        bool isMainFrame,
        const char* error) override;
    virtual void OnBindingsReleased(int frameId,
        const wchar_t* path,
        bool isMainFrame) override;
    virtual void OnNavigateTo(const wchar_t* path) override;
    virtual void OnScriptMessage(MessageLevel level, const wchar_t* message, const wchar_t* sourceId, int line) override;
    virtual void OnCursorChanged(Coherent::UI::CursorTypes cursor) override;
    virtual void OnJavaScriptMessage(const wchar_t* message, const wchar_t* defaultPrompt, const wchar_t* frameUrl, int messageType) override;
    virtual void OnError(const Coherent::UI::ViewError& error) override;
    virtual void OnCallback(const char* eventName, const Coherent::UI::EventArguments& arguments) override;
    virtual void OnRequestMediaStream(Coherent::UI::MediaStreamRequest* request) override;

    virtual void Release() override;

public:
    typedef TArray<TWeakObjectPtr<UCoherentBaseComponent>> WeakCoherentComponentsArray;
    static WeakCoherentComponentsArray::TIterator GetUCoherentBaseComponentIterator(UWorld* world);
    void ViewRequested();
private:
    bool bIsReadyForBindings;
    bool bIsReadyForScripting;
    bool bIsMouseOnUI;
    bool bIsReadyForFinishDestroy;

    UPROPERTY()
    UCoherentMediaRequestHandler* m_MediaRequestHandler;

};