Files
UnrealEngineUWP/Engine/Source/Developer/TargetDeviceServices/Public/ITargetDeviceProxyManager.h
ryan durand 471d972e62 Updating copyright for Engine Developer.
#rnx
#rb none


#ROBOMERGE-SOURCE: CL 10869240 via CL 10869516 via CL 10869902
#ROBOMERGE-BOT: (v613-10869866)

[CL 10870584 by ryan durand in Main branch]
2019-12-26 15:32:37 -05:00

101 lines
3.7 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"
class FString;
class ITargetDeviceProxy;
class ITargetDeviceProxyManager;
class ITargetDeviceServiceManager;
/** Type definition for shared pointers to instances of ITargetDeviceProxyManager. */
UE_DEPRECATED(4.16, "ITargetDeviceProxyManagerPtr is deprecated. Please use 'TSharedPtr<ITargetDeviceProxyManager>' instead!")
typedef TSharedPtr<class ITargetDeviceProxyManager> ITargetDeviceProxyManagerPtr;
/** Type definition for shared references to instances of ITargetDeviceProxyManager. */
UE_DEPRECATED(4.16, "ITargetDeviceProxyManagerRef is deprecated. Please use 'TSharedPtr<ITargetDeviceProxyManager>' instead!")
typedef TSharedRef<class ITargetDeviceProxyManager> ITargetDeviceProxyManagerRef;
/**
* Interface for device proxy managers.
*/
class ITargetDeviceProxyManager
{
public:
/**
* Finds or adds a device proxy for the specified device name.
*
* @param Name The name of the device to create the proxy for.
* @return The device proxy.
* @see FindProxy, FindProxyDeviceForTargetDevice, GetProxies
*/
virtual TSharedRef<ITargetDeviceProxy> FindOrAddProxy(const FString& Name) = 0;
/**
* Finds the device proxy for the specified device name.
*
* @param Name The name of the device to create the proxy for.
* @return The device proxy, or nullptr if it couldn't be found.
* @see FindOrAddProxy, FindProxyDeviceForTargetDevice, GetProxies
*/
virtual TSharedPtr<ITargetDeviceProxy> FindProxy(const FString& Name) = 0;
/**
* Finds the device proxy for the specified target device id.
*
* @param DeviceId The identifier of the target device to create the proxy for.
* @return The device proxy, or nullptr if it couldn't be found.
* @see FindOrAddProxy, FindProxy, GetProxies
*/
virtual TSharedPtr<ITargetDeviceProxy> FindProxyDeviceForTargetDevice(const FString& DeviceId) = 0;
/**
* Gets a list of devices found by the device discovery.
*
* @param PlatformName The the name of the target platform to get proxies for (or empty string for all proxies).
* @param IncludeUnshared Whether to include devices that are not being shared with the local user.
* @param OutProxies Will hold the list of devices found by the locator.
* @see FindOrAddProxy, FindProxy, FindProxyDeviceForTargetDevice
*/
virtual void GetProxies(FName TargetPlatformName, bool IncludeUnshared, TArray<TSharedPtr<ITargetDeviceProxy>>& OutProxies) = 0;
/**
* Gets a list of proxies created by the device discovery, including the "All device" proxies
*
* @param PlatformName The the name of the target platform to get proxies for (or empty string for all proxies).
* @param OutProxies Will hold the list of devices found by the locator.
* @see FindOrAddProxy, FindProxy, FindProxyDeviceForTargetDevice
*/
virtual void GetAllProxies(FName TargetPlatformName, TArray<TSharedPtr<ITargetDeviceProxy>>& OutProxies) = 0;
public:
/**
* Gets an event delegate that is executed when a target device proxy was added.
*
* @return The event delegate.
*/
DECLARE_EVENT_OneParam(ITargetDeviceServiceManager, FOnTargetDeviceProxyAdded, const TSharedRef<ITargetDeviceProxy>& /*AddedProxy*/);
virtual FOnTargetDeviceProxyAdded& OnProxyAdded() = 0;
/**
* Gets an event delegate that is executed when a target device proxy was removed.
*
* @return The event delegate.
*/
DECLARE_EVENT_OneParam(ITargetDeviceServiceManager, FOnTargetDeviceProxyRemoved, const TSharedRef<ITargetDeviceProxy>& /*RemovedProxy*/);
virtual FOnTargetDeviceProxyRemoved& OnProxyRemoved() = 0;
public:
/** Virtual destructor. */
virtual ~ITargetDeviceProxyManager() { }
};