UCesiumIonServer Class Reference

Defines a Cesium ion Server. More...

#include <CesiumIonServer.h>

Inheritance diagram for UCesiumIonServer:

Static Public Member Functions
static UCesiumIonServer *	GetDefaultServer ()
	Gets the default Cesium ion Server (ion.cesium.com).
static UCesiumIonServer *	GetServerForNewObjects ()
	Gets the current server to be assigned to new objects.
static void	SetServerForNewObjects (UCesiumIonServer *Server)
	Sets the current server to be assigned to new objects.

Public Attributes
FString	DisplayName = "ion.cesium.com"
	The name to display for this server.
FString	ServerUrl = "https://ion.cesium.com"
	The main URL of the Cesium ion server.
FString	ApiUrl = "https://api.cesium.com"
	The URL of the main API endpoint of the Cesium ion server.
int64	OAuth2ApplicationID = 190
	The application ID to use to log in to this server using OAuth2.
FString	DefaultIonAccessTokenId
	The ID of the default access token to use to access Cesium ion assets at runtime.
FString	DefaultIonAccessToken
	The default token used to access Cesium ion assets at runtime.

Detailed Description

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.

Definition at line 18 of file CesiumIonServer.h.

Member Function Documentation

GetDefaultServer()

static UCesiumIonServer * UCesiumIonServer::GetDefaultServer ( )

static

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.

GetServerForNewObjects()

static UCesiumIonServer * UCesiumIonServer::GetServerForNewObjects ( )

static

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.

SetServerForNewObjects()

static void UCesiumIonServer::SetServerForNewObjects ( UCesiumIonServer * Server )

static

Sets the current server to be assigned to new objects.

If set to nullptr, the value of GetDefault will be returned from GetCurrentForNewObjects.

Member Data Documentation

ApiUrl

FString UCesiumIonServer::ApiUrl = "https://api.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.

Definition at line 87 of file CesiumIonServer.h.

DefaultIonAccessToken

FString UCesiumIonServer::DefaultIonAccessToken

The default token used to access Cesium ion assets at runtime.

This token is embedded in packaged games for use at runtime.

Definition at line 122 of file CesiumIonServer.h.

DefaultIonAccessTokenId

FString UCesiumIonServer::DefaultIonAccessTokenId

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.

Definition at line 111 of file CesiumIonServer.h.

DisplayName

FString UCesiumIonServer::DisplayName = "ion.cesium.com"

The name to display for this server.

Definition at line 64 of file CesiumIonServer.h.

OAuth2ApplicationID

int64 UCesiumIonServer::OAuth2ApplicationID = 190

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.

Definition at line 99 of file CesiumIonServer.h.

ServerUrl

FString UCesiumIonServer::ServerUrl = "https://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.

Definition at line 75 of file CesiumIonServer.h.

---

The documentation for this class was generated from the following file:

• Source/CesiumRuntime/Public/CesiumIonServer.h