136 lines
4.2 KiB
C++
136 lines
4.2 KiB
C++
// Copyright 2020-2024 CesiumGS, Inc. and Contributors
|
|
|
|
#pragma once
|
|
|
|
#include "Engine/DataAsset.h"
|
|
#include "UObject/Object.h"
|
|
#include "CesiumIonServer.generated.h"
|
|
|
|
namespace CesiumAsync {
|
|
template <typename T> class Future;
|
|
}
|
|
|
|
/**
|
|
* Defines a Cesium ion Server. This may be the public (SaaS) Cesium ion server
|
|
* at ion.cesium.com, or it may be a self-hosted instance.
|
|
*/
|
|
UCLASS()
|
|
class CESIUMRUNTIME_API UCesiumIonServer : public UDataAsset {
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
/**
|
|
* Gets the default Cesium ion Server (ion.cesium.com).
|
|
*
|
|
* It is expected to be found at
|
|
* `/Game/CesiumSettings/CesiumIonServers/CesiumIonSaaS`. In the Editor, it
|
|
* will be created if it does not already exist, so this method always returns
|
|
* a valid instance. At runtime, this method returns nullptr if the object
|
|
* does not exist.
|
|
*/
|
|
static UCesiumIonServer* GetDefaultServer();
|
|
|
|
/**
|
|
* Gets the current server to be assigned to new objects. In the Editor, this
|
|
* is the server that is currently selected on the Cesium panel. At runtime,
|
|
* this returns `GetDefault`, unless `SetCurrentForNewObjects` has been called
|
|
* to set it to something different.
|
|
*/
|
|
static UCesiumIonServer* GetServerForNewObjects();
|
|
|
|
/**
|
|
* Sets the current server to be assigned to new objects. If set to nullptr,
|
|
* the value of `GetDefault` will be returned from `GetCurrentForNewObjects`.
|
|
*/
|
|
static void SetServerForNewObjects(UCesiumIonServer* Server);
|
|
|
|
#if WITH_EDITOR
|
|
/**
|
|
* Gets or creates a server from a given API URL. This is used for backward
|
|
* compatibility with the old `IonAssetEndpointUrl` property. The new server,
|
|
* if needed, is created in `/Game/CesiumSettings/CesiumIonServers`.
|
|
*/
|
|
static UCesiumIonServer* GetBackwardCompatibleServer(const FString& apiUrl);
|
|
#endif
|
|
|
|
/**
|
|
* The name to display for this server.
|
|
*/
|
|
UPROPERTY(
|
|
EditAnywhere,
|
|
AssetRegistrySearchable,
|
|
Category = "Cesium",
|
|
meta = (DisplayName = "Display Name"))
|
|
FString DisplayName = "ion.cesium.com";
|
|
|
|
/**
|
|
* The main URL of the Cesium ion server. For example, the server URL for the
|
|
* public Cesium ion is https://ion.cesium.com.
|
|
*/
|
|
UPROPERTY(
|
|
EditAnywhere,
|
|
AssetRegistrySearchable,
|
|
Category = "Cesium",
|
|
meta = (DisplayName = "Server URL"))
|
|
FString ServerUrl = "https://ion.cesium.com";
|
|
|
|
/**
|
|
* The URL of the main API endpoint of the Cesium ion server. For example, for
|
|
* the default, public Cesium ion server, this is `https://api.cesium.com`. If
|
|
* left blank, the API URL is automatically inferred from the Server URL.
|
|
*/
|
|
UPROPERTY(
|
|
EditAnywhere,
|
|
AssetRegistrySearchable,
|
|
Category = "Cesium",
|
|
meta = (DisplayName = "API URL"))
|
|
FString ApiUrl = "https://api.cesium.com";
|
|
|
|
/**
|
|
* The application ID to use to log in to this server using OAuth2. This
|
|
* OAuth2 application must be configured on the server with the exact URL
|
|
* `http://127.0.0.1/cesium-for-unreal/oauth2/callback`.
|
|
*/
|
|
UPROPERTY(
|
|
EditAnywhere,
|
|
AssetRegistrySearchable,
|
|
Category = "Cesium",
|
|
meta = (DisplayName = "OAuth Application ID"))
|
|
int64 OAuth2ApplicationID = 190;
|
|
|
|
/**
|
|
* The ID of the default access token to use to access Cesium ion assets at
|
|
* runtime. This property may be an empty string, in which case the ID is
|
|
* found by searching the logged-in Cesium ion account for the
|
|
* DefaultIonAccessToken.
|
|
*/
|
|
UPROPERTY(
|
|
EditAnywhere,
|
|
Category = "Cesium",
|
|
meta = (DisplayName = "Default Cesium ion Access Token ID"))
|
|
FString DefaultIonAccessTokenId;
|
|
|
|
/**
|
|
* The default token used to access Cesium ion assets at runtime. This token
|
|
* is embedded in packaged games for use at runtime.
|
|
*/
|
|
UPROPERTY(
|
|
EditAnywhere,
|
|
AssetRegistrySearchable,
|
|
Category = "Cesium",
|
|
meta = (DisplayName = "Default Cesium ion Access Token"))
|
|
FString DefaultIonAccessToken;
|
|
|
|
#if WITH_EDITOR
|
|
/**
|
|
* If the `ApiUrl` property is blank, this method asynchronously resolves it
|
|
* by consulting with the `ServerUrl`. If the `ApiUrl` is not blank, this
|
|
* method returns an already-resolved future.
|
|
*/
|
|
CesiumAsync::Future<void> ResolveApiUrl();
|
|
#endif
|
|
|
|
private:
|
|
static UCesiumIonServer* _pDefaultForNewObjects;
|
|
};
|