app_view.hpp

Go to the documentation of this file.

// Copyright 2008-2024 by Rightware. All rights reserved.

#ifndef APP_VIEW_HPP
#define APP_VIEW_HPP

#include <kanzi/core.ui/message/message_arguments.hpp>
#include <kanzi/core/metadata/metaclass.hpp>

#include <app_view_controller.hpp>

namespace kanzi
{

// Forward declarations.
class Matrix4x4;
class Node2D;
class Vector2;
struct TouchPoint;

namespace plugin
{

namespace appview
{

class ForwardingManipulator;
using ForwardingManipulatorSharedPtr = shared_ptr<ForwardingManipulator>;

class APP_VIEW_PLUGIN_API AppViewConcept
{
public:
    static PropertyType<string> AppNameProperty;
    static PropertyType<string> VirtualDisplayNameProperty;
    static PropertyType<int> VirtualDisplayWidthProperty;
    static PropertyType<int> VirtualDisplayHeightProperty;
    static PropertyType<int> VirtualDisplayDensityProperty;
    static PropertyType<bool> CanExitAppProperty;
    static PropertyType<ResourceSharedPtr> OverrideMaterialProperty;

    static PropertyType<string> MessageArgumentAppNameProperty;
    static PropertyType<bool> MessageArgumentCanExitAppProperty;
    static PropertyType<int> MessageArgumentVirtualDisplayWidthProperty;
    static PropertyType<int> MessageArgumentVirtualDisplayHeightProperty;
    static PropertyType<int> MessageArgumentVirtualDisplayDensityProperty;

    class StartAppMessageArguments : public MessageArguments
    {
    public:
        KZ_MESSAGE_ARGUMENTS_METACLASS_BEGIN(
            StartAppMessageArguments, MessageArguments, "Kanzi.AppView.AppViewConcept.StartAppMessageArguments")
            KZ_METACLASS_PROPERTY_TYPE(MessageArgumentAppNameProperty)
            KZ_METACLASS_PROPERTY_TYPE(MessageArgumentCanExitAppProperty)
        KZ_METACLASS_END()

        static PropertyTypeEditorInfoSharedPtr makeEditorInfo()
        {
            return KZ_DECLARE_EDITOR_METADATA(
                metadata.legacyName = "AppView.AppViewConcept.StartAppMessageArguments";);
        }
    };

    class FinishAppMessageArguments : public MessageArguments
    {
    public:
        KZ_MESSAGE_ARGUMENTS_METACLASS_BEGIN(
            FinishAppMessageArguments, MessageArguments, "Kanzi.AppView.AppViewConcept.FinishAppMessageArguments")
        KZ_METACLASS_END()
    };

    class NavigateBackMessageArguments : public MessageArguments
    {
    public:
        KZ_MESSAGE_ARGUMENTS_METACLASS_BEGIN(
            NavigateBackMessageArguments, MessageArguments, "Kanzi.AppView.AppViewConcept.NavigateBackMessageArguments")
        KZ_METACLASS_END()

        static PropertyTypeEditorInfoSharedPtr makeEditorInfo()
        {
            return KZ_DECLARE_EDITOR_METADATA(
                metadata.legacyName = "AppView.AppViewConcept.NavigateBackMessageArguments";);
        }
    };

    class UpdateVirtualDisplayMessageArguments : public MessageArguments
    {
    public:
        KZ_MESSAGE_ARGUMENTS_METACLASS_BEGIN(
            UpdateVirtualDisplayMessageArguments, MessageArguments, "Kanzi.AppView.AppViewConcept.UpdateVirtualDisplayMessageArguments")
            KZ_METACLASS_PROPERTY_TYPE(MessageArgumentVirtualDisplayWidthProperty)
            KZ_METACLASS_PROPERTY_TYPE(MessageArgumentVirtualDisplayHeightProperty)
            KZ_METACLASS_PROPERTY_TYPE(MessageArgumentVirtualDisplayDensityProperty)
        KZ_METACLASS_END()

        static PropertyTypeEditorInfoSharedPtr makeEditorInfo()
        {
            return KZ_DECLARE_EDITOR_METADATA(
                metadata.legacyName = "AppView.AppViewConcept.UpdateVirtualDisplayMessageArguments";);
        }
    };

    static MessageType<StartAppMessageArguments> StartAppMessage;
    static MessageType<FinishAppMessageArguments> FinishAppMessage;
    static MessageType<NavigateBackMessageArguments> NavigateBackMessage;
    static MessageType<UpdateVirtualDisplayMessageArguments> UpdateVirtualDisplayMessage;
    static MessageType<MessageArguments> PauseAppMessage;
    static MessageType<MessageArguments> ResumeAppMessage;

    KZ_MIXIN_METACLASS_BEGIN(AppViewConcept, "Kanzi.AppView.AppViewConcept")
        KZ_METACLASS_PROPERTY_TYPE(AppNameProperty)
        KZ_METACLASS_PROPERTY_TYPE(VirtualDisplayNameProperty)
        KZ_METACLASS_PROPERTY_TYPE(VirtualDisplayWidthProperty)
        KZ_METACLASS_PROPERTY_TYPE(VirtualDisplayHeightProperty)
        KZ_METACLASS_PROPERTY_TYPE(VirtualDisplayDensityProperty)
        KZ_METACLASS_PROPERTY_TYPE(CanExitAppProperty)
        KZ_METACLASS_PROPERTY_TYPE(OverrideMaterialProperty)

        KZ_METACLASS_MESSAGE_TYPE(StartAppMessage)
        KZ_METACLASS_MESSAGE_TYPE(FinishAppMessage)
        KZ_METACLASS_MESSAGE_TYPE(NavigateBackMessage)
        KZ_METACLASS_MESSAGE_TYPE(UpdateVirtualDisplayMessage)
        KZ_METACLASS_MESSAGE_TYPE(PauseAppMessage)
        KZ_METACLASS_MESSAGE_TYPE(ResumeAppMessage)
    KZ_METACLASS_END()

    static PropertyTypeEditorInfoSharedPtr makeEditorInfo();
};

template <typename TBaseClass, typename TDerivedClass>
class APP_VIEW_PLUGIN_API AppViewConceptImpl : public TBaseClass, public AppViewConcept
{
public:
    KZ_TEMPLATE_METACLASS_BEGIN(AppViewConceptImpl, TBaseClass)
        KZ_METACLASS_MIXIN(AppViewConcept)
    KZ_METACLASS_END()

    static PropertyTypeEditorInfoSharedPtr makeEditorInfo();

protected:
    explicit AppViewConceptImpl(Domain* domain, string_view name);

    void initialize();

    void onAttached() override;
    void onDetached() override;

    void onFrameAvailable();

    TextureSharedPtr getAppViewTexture();
    MaterialSharedPtr getAppViewMaterial();

    virtual void setupMaterialOverride() = 0;
    virtual bool calculateHitUV(
        const TouchPoint& touchPoint,
        Vector2& outHitUV) = 0;
    virtual void onAppViewTextureChanged() = 0;

    void onNodePropertyChanged(AbstractPropertyType propertyType, PropertyNotificationReason reason) override;

    void handleStartAppMessage(const StartAppMessageArguments& messageArguments);
    void handleFinishAppMessage(FinishAppMessageArguments& messageArguments);
    void handleNavigateBackMessage(const NavigateBackMessageArguments& messageArguments);
    void handleUpdateVirtualDisplayMessage(const UpdateVirtualDisplayMessageArguments& messageArguments);

private:
    AppViewControllerSharedPtr m_appViewController;
    ForwardingManipulatorSharedPtr m_forwardingManipulator;

    TDerivedClass* getThisObject()
    {
        return static_cast<TDerivedClass*>(this);
    }

    const TDerivedClass* getThisObject() const
    {
        return static_cast<const TDerivedClass*>(this);
    }

    void setupInputHandling();
    void setupController();
    void resetController();
    void setupMaterial();
    void startApp(const string& appName, bool canExitApp);
    void finishApp();

    Vector2 getVirtualDisplaySize() const;

    Matrix4x4 m_stMatrix;
    int m_textureId = 0;
};

}

}

}

#endif