o3de-extras/Gems/OpenXRVk/Code/Source/OpenXRVkInteractionProfilesAsset.cpp

/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */

#include <OpenXRVk/OpenXRVkInteractionProfilesAsset.h>
#include <OpenXRVk/OpenXRVkAssetsValidator.h>

namespace OpenXRVk
{
    ///////////////////////////////////////////////////////////
    /// OpenXRInteractionComponentPathDescriptor
    XrActionType OpenXRInteractionComponentPathDescriptor::GetXrActionType(AZStd::string_view actionTypeStr)
    {
        if (actionTypeStr == s_TypeBoolStr)
        {
            return XR_ACTION_TYPE_BOOLEAN_INPUT;
        }
        else if (actionTypeStr == s_TypeFloatStr)
        {
            return XR_ACTION_TYPE_FLOAT_INPUT;
        }
        else if (actionTypeStr == s_TypeVector2Str)
        {
            return XR_ACTION_TYPE_VECTOR2F_INPUT;
        }
        else if (actionTypeStr == s_TypePoseStr)
        {
            return XR_ACTION_TYPE_POSE_INPUT;
        }
        else if (actionTypeStr == s_TypeVibrationStr)
        {
            return XR_ACTION_TYPE_VIBRATION_OUTPUT;
        }
        return XR_ACTION_TYPE_MAX_ENUM;
    }


    XrActionType OpenXRInteractionComponentPathDescriptor::GetXrActionType() const
    {
        return GetXrActionType(m_actionTypeStr);
    }


    static AZStd::vector<AZStd::string> GetEditorXrActionTypeNames()
    {
        static AZStd::vector<AZStd::string> s_actionTypeNames = {
                {OpenXRInteractionComponentPathDescriptor::s_TypeBoolStr   },
                {OpenXRInteractionComponentPathDescriptor::s_TypeFloatStr  },
                {OpenXRInteractionComponentPathDescriptor::s_TypeVector2Str},
                {OpenXRInteractionComponentPathDescriptor::s_TypePoseStr   },
                {OpenXRInteractionComponentPathDescriptor::s_TypeVibrationStr   },
        };
        return s_actionTypeNames;
    }


    void OpenXRInteractionComponentPathDescriptor::Reflect(AZ::ReflectContext* context)
    {
        AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context);
        if (serialize)
        {
            serialize->Class<OpenXRInteractionComponentPathDescriptor>()
                ->Version(1)
                ->Field("Name", &OpenXRInteractionComponentPathDescriptor::m_name)
                ->Field("Path", &OpenXRInteractionComponentPathDescriptor::m_path)
                ->Field("ActionType", &OpenXRInteractionComponentPathDescriptor::m_actionTypeStr)
                ;

            AZ::EditContext* edit = serialize->GetEditContext();
            if (edit)
            {
                edit->Class<OpenXRInteractionComponentPathDescriptor>("Component Path", "An OpenXR Component Path that is supported by an OpenXR User Path")
                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
                    ->Attribute(AZ::Edit::Attributes::NameLabelOverride, &OpenXRInteractionComponentPathDescriptor::GetEditorText)
                    ->Attribute(AZ::Edit::Attributes::AutoExpand, true)
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionComponentPathDescriptor::m_name, "Name", "User friendly name.")
                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::AttributesAndValues)
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionComponentPathDescriptor::m_path, "Path", "An OpenXR Path string that starts with '/' BUT is relative to a User Path.")
                    ->DataElement(AZ::Edit::UIHandlers::ComboBox, &OpenXRInteractionComponentPathDescriptor::m_actionTypeStr, "Action Type", "Data type of this action.")
                    ->Attribute(AZ::Edit::Attributes::StringList, &GetEditorXrActionTypeNames)
                    ;
            }
        }
    }


    AZStd::string OpenXRInteractionComponentPathDescriptor::GetEditorText()
    {
        return m_name.empty() ? "<Unknown Component Path>" : m_name;
    }

    /// OpenXRInteractionComponentPathDescriptor
    ///////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////
    /// OpenXRInteractionUserPathDescriptor
    void OpenXRInteractionUserPathDescriptor::Reflect(AZ::ReflectContext* context)
    {
        AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context);
        if (serialize)
        {
            serialize->Class<OpenXRInteractionUserPathDescriptor>()
                ->Version(1)
                ->Field("Name", &OpenXRInteractionUserPathDescriptor::m_name)
                ->Field("Path", &OpenXRInteractionUserPathDescriptor::m_path)
                ->Field("ComponentPaths", &OpenXRInteractionUserPathDescriptor::m_componentPathDescriptors)
                ;

            AZ::EditContext* edit = serialize->GetEditContext();
            if (edit)
            {
                edit->Class<OpenXRInteractionUserPathDescriptor>("User Path", "Represents a User Path supported by an Interaction Profile")
                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
                    ->Attribute(AZ::Edit::Attributes::NameLabelOverride, &OpenXRInteractionUserPathDescriptor::GetEditorText)
                    ->Attribute(AZ::Edit::Attributes::AutoExpand, true)
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionUserPathDescriptor::m_name, "Name", "User friendly name.")
                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::AttributesAndValues)
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionUserPathDescriptor::m_path, "Path", "An OpenXR Path string that starts with '/'.")
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionUserPathDescriptor::m_componentPathDescriptors, "Component Paths", "List of component paths supported by this User Path")
                    ;
            }
        }
    }


    AZStd::string OpenXRInteractionUserPathDescriptor::GetEditorText()
    {
        return m_name.empty() ? "<Unknown User Path>" : m_name;
    }


    const OpenXRInteractionComponentPathDescriptor* OpenXRInteractionUserPathDescriptor::GetComponentPathDescriptor(const AZStd::string& componentPathName) const
    {
        for (const auto& componentPathDescriptor : m_componentPathDescriptors)
        {
            if (componentPathDescriptor.m_name == componentPathName)
            {
                return &componentPathDescriptor;
            }
        }
        return nullptr;
    }

    /// OpenXRInteractionUserPathDescriptor
    ///////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////
    /// OpenXRInteractionProfileDescriptor
    void OpenXRInteractionProfileDescriptor::Reflect(AZ::ReflectContext* context)
    {
        OpenXRInteractionComponentPathDescriptor::Reflect(context);
        OpenXRInteractionUserPathDescriptor::Reflect(context);

        AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context);
        if (serialize)
        {
            serialize->Class<OpenXRInteractionProfileDescriptor>()
                ->Version(1)
                ->Field("UniqueName", &OpenXRInteractionProfileDescriptor::m_name)
                ->Field("Path", &OpenXRInteractionProfileDescriptor::m_path)
                ->Field("UserPathDescriptors", &OpenXRInteractionProfileDescriptor::m_userPathDescriptors)
                ->Field("CommonComponentPathDescriptors", &OpenXRInteractionProfileDescriptor::m_commonComponentPathDescriptors)
                ;

            AZ::EditContext* edit = serialize->GetEditContext();
            if (edit)
            {
                edit->Class<OpenXRInteractionProfileDescriptor>(
                    "Interaction Profile", "Defines an OpenXR Interaction Profile Supported by O3DE.")
                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
                    ->Attribute(AZ::Edit::Attributes::NameLabelOverride, &OpenXRInteractionProfileDescriptor::GetEditorText)
                    ->Attribute(AZ::Edit::Attributes::AutoExpand, true)
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionProfileDescriptor::m_name, "Unique Name", "Unique name across all interaction profiles")
                    ->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::AttributesAndValues)
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionProfileDescriptor::m_path, "Path", "OpenXR Canonical Path for this interation profile.")
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionProfileDescriptor::m_userPathDescriptors, "User Paths", "List of user paths")
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionProfileDescriptor::m_commonComponentPathDescriptors, "Common Component Paths", "List of component paths supported by all User Paths")
                    ;
            }
        }
    }


    AZStd::string OpenXRInteractionProfileDescriptor::GetEditorText()
    {
        return m_name.empty() ? "<Unknown Profile>" : m_name;
    }


    const OpenXRInteractionUserPathDescriptor* OpenXRInteractionProfileDescriptor::GetUserPathDescriptor(const AZStd::string& userPathName) const
    {
        for (const auto& userPathDescriptor : m_userPathDescriptors)
        {
            if (userPathDescriptor.m_name == userPathName)
            {
                return &userPathDescriptor;
            }
        }
        return nullptr;
    }


    const OpenXRInteractionComponentPathDescriptor* OpenXRInteractionProfileDescriptor::GetCommonComponentPathDescriptor(const AZStd::string& componentPathName) const
    {
        for (const auto& componentPathDescriptor : m_commonComponentPathDescriptors)
        {
            if (componentPathDescriptor.m_name == componentPathName)
            {
                return &componentPathDescriptor;
            }
        }
        return nullptr;
    }


    const OpenXRInteractionComponentPathDescriptor* OpenXRInteractionProfileDescriptor::GetComponentPathDescriptor(const OpenXRInteractionUserPathDescriptor& userPathDescriptor,
        const AZStd::string& componentPathName) const
    {
        auto componentPathDescriptor = userPathDescriptor.GetComponentPathDescriptor(componentPathName);
        if (!componentPathDescriptor)
        {
            // Look in common paths
            return GetCommonComponentPathDescriptor(componentPathName);
        }
        return componentPathDescriptor;
    }


    AZStd::string OpenXRInteractionProfileDescriptor::GetComponentAbsolutePath(const OpenXRInteractionUserPathDescriptor& userPathDescriptor,
        const AZStd::string& componentPathName) const
    {
        // First check if the user path owns the component path, if not, search in the common components list.
        auto componentPathDescriptor = GetComponentPathDescriptor(userPathDescriptor, componentPathName);
        if (!componentPathDescriptor)
        {
            return {};
        }
        return userPathDescriptor.m_path + componentPathDescriptor->m_path;
    }
    /// OpenXRInteractionProfileDescriptor
    ///////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////
    /// OpenXRInteractionProfilesAsset
    void OpenXRInteractionProfilesAsset::Reflect(AZ::ReflectContext* context)
    {
        OpenXRInteractionProfileDescriptor::Reflect(context);

        AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context);
        if (serialize)
        {
            serialize->Class<OpenXRInteractionProfilesAsset, AZ::Data::AssetData>()
                ->Version(1)
                ->Attribute(AZ::Edit::Attributes::EnableForAssetEditor, true)
                ->Field("InteractionProfiles", &OpenXRInteractionProfilesAsset::m_interactionProfileDescriptors)
                ;

            AZ::EditContext* edit = serialize->GetEditContext();
            if (edit)
            {
                edit->Class<OpenXRInteractionProfilesAsset>(
                    s_assetTypeName, "Defines the OpenXR Interaction Profiles supported by O3DE.")
                    ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
                    ->Attribute(AZ::Edit::Attributes::AutoExpand, true)
                    ->DataElement(AZ::Edit::UIHandlers::Default, &OpenXRInteractionProfilesAsset::m_interactionProfileDescriptors, "Interaction Profiles", "List of interaction profile descriptors.")
                    ;
            }
        }
    }


    const OpenXRInteractionProfileDescriptor* OpenXRInteractionProfilesAsset::GetInteractionProfileDescriptor(const AZStd::string& profileName) const
    {
        for (const auto& profileDescriptor : m_interactionProfileDescriptors)
        {
            if (profileName == profileDescriptor.m_name)
            {
                return &profileDescriptor;
            }
        }
        return nullptr;
    }


    const AZStd::string& OpenXRInteractionProfilesAsset::GetActionPathTypeStr(const AZStd::string& profileName, const AZStd::string& userPathName, const AZStd::string& componentPathName) const
    {
        static const AZStd::string emptyStr;
        const auto profileDescriptor = GetInteractionProfileDescriptor(profileName);
        if (!profileDescriptor)
        {
            return emptyStr;
        }
        const auto userPathDescriptor = profileDescriptor->GetUserPathDescriptor(userPathName);
        if (!userPathDescriptor)
        {
            return emptyStr;
        }
        const auto componentPathDescriptor = profileDescriptor->GetComponentPathDescriptor(*userPathDescriptor, componentPathName);
        if (!componentPathDescriptor)
        {
            return emptyStr;
        }
        return componentPathDescriptor->m_actionTypeStr;
    }

    /// OpenXRInteractionProfilesAsset
    ///////////////////////////////////////////////////////////


    ///////////////////////////////////////////////////////////
    /// OpenXRInteractionProfilesAssetHandler
    OpenXRInteractionProfilesAssetHandler::OpenXRInteractionProfilesAssetHandler()
        : AzFramework::GenericAssetHandler<OpenXRInteractionProfilesAsset>(
            OpenXRInteractionProfilesAsset::s_assetTypeName,
            "Other",
            OpenXRInteractionProfilesAsset::s_assetExtension)
    {
    }
    
    bool OpenXRInteractionProfilesAssetHandler::SaveAssetData(const AZ::Data::Asset<AZ::Data::AssetData>& asset, AZ::IO::GenericStream* stream)
    {
        auto profileAsset = asset.GetAs<OpenXRInteractionProfilesAsset>();
        if (!profileAsset)
        {
            AZ_Error(LogName, false, "This should be an OpenXR Interaction Profile Asset, as this is the only type this handler can process.");
            return false;
        }
        
        auto outcome = OpenXRVkAssetsValidator::ValidateInteractionProfilesAsset(*profileAsset);
        if (!outcome.IsSuccess())
        {
            AZ_Error(LogName, false, "Can't save this interaction profiles asset. Reason:\n%s\n", outcome.GetError().c_str());
            return false;
        }
    
        if (!m_serializeContext)
        {
            AZ_Error(LogName, false, "Can't save the OpenXR Interaction Profile Asset without a serialize context.");
            return false;
        }
    
        return AZ::Utils::SaveObjectToStream(*stream, AZ::ObjectStream::ST_JSON, profileAsset,
            asset->RTTI_GetType(), m_serializeContext);
    }
    /// OpenXRInteractionProfilesAssetHandler
    ///////////////////////////////////////////////////////////

} // namespace OpenXRVk