portalutils.h

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
#pragma once
 
// External Includes
#include <nap/core.h>
#include <apievent.h>
 
namespace nap
{
    namespace portal
    {
        inline constexpr const char* eventHeaderName = "portal_event_header";           
        inline constexpr const char* portalIDArgName = "portal_id";                     
        inline constexpr const char* eventTypeArgName = "portal_event_type";            
        inline constexpr const char* itemTypeArgName = "portal_item_type";              
        inline constexpr const char* itemValueArgName = "portal_item_value";            
        inline constexpr const char* itemMinArgName = "portal_item_min";                
        inline constexpr const char* itemMaxArgName = "portal_item_max";                
        inline constexpr const char* itemClampArgName = "portal_item_clamp";            
        inline constexpr const char* dropDownItemNames = "portal_dropdown_item_names";
    }
 
    enum class EPortalEventType : int
    {
        Request     = 0,    
        Response    = 1,    
        Update      = 2,    
        Invalid     = -1    
    };
 
    enum class EPortalItemButtonEvent : int
    {
        Click = 0,      
        Press = 1,      
        Release = 2,    
        Invalid = -1    
    };
 
    struct NAPAPI PortalEventHeader
    {
        std::string mID;                                        
        std::string mPortalID;                                  
        EPortalEventType mType = EPortalEventType::Invalid;     
    };
 
    NAPAPI std::string getPortalEventTypeString(const EPortalEventType& type);
 
    NAPAPI EPortalEventType getPortalEventType(const std::string& type);
 
    NAPAPI std::string getPortalItemButtonEventString(const EPortalItemButtonEvent& event);
 
    NAPAPI EPortalItemButtonEvent getPortalItemButtonEvent(const std::string& event);
 
    NAPAPI bool extractPortalEventHeader(const APIEventPtr& event, PortalEventHeader& outHeader, utility::ErrorState& error);
 
    NAPAPI APIEventPtr createPortalEventHeader(const PortalEventHeader& header);
}