Cesium for Unity 1.15.2
Loading...
Searching...
No Matches
CesiumForUnity.CesiumIonServer Class Reference

Defines a Cesium ion Server. More...

Inheritance diagram for CesiumForUnity.CesiumIonServer:

Public Attributes

string serverUrl = "https://ion.cesium.com"
 The main URL of the Cesium ion server.
 
string apiUrl = "https://api.cesium.com"
 The URL of the main API endpoint of the Cesium ion server.
 
long oauth2ApplicationID = 381
 The application ID to use to log in to this server using OAuth2.
 
string defaultIonAccessTokenId = ""
 The ID of the default access token to use to access Cesium ion assets at runtime.
 
string defaultIonAccessToken = ""
 The default token used to access Cesium ion assets at runtime.
 

Properties

static CesiumIonServer defaultServer [get]
 Gets the default Cesium ion Server (ion.cesium.com).
 
static CesiumIonServer serverForNewObjects [get, set]
 Gets the current Cesium ion server that should be assigned to newly-created objects.
 

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 13 of file CesiumIonServer.cs.

Member Data Documentation

◆ apiUrl

string CesiumForUnity.CesiumIonServer.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 26 of file CesiumIonServer.cs.

◆ defaultIonAccessToken

string CesiumForUnity.CesiumIonServer.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 47 of file CesiumIonServer.cs.

◆ defaultIonAccessTokenId

string CesiumForUnity.CesiumIonServer.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 41 of file CesiumIonServer.cs.

◆ oauth2ApplicationID

long CesiumForUnity.CesiumIonServer.oauth2ApplicationID = 381

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 33 of file CesiumIonServer.cs.

◆ serverUrl

string CesiumForUnity.CesiumIonServer.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 19 of file CesiumIonServer.cs.

Property Documentation

◆ defaultServer

CesiumIonServer CesiumForUnity.CesiumIonServer.defaultServer
staticget

Gets the default Cesium ion Server (ion.cesium.com).

It is expected to be found at Assets/CesiumSettings/CesiumIonServers/ion.cesium.com. 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 null if the object does not exist.

Definition at line 64 of file CesiumIonServer.cs.

◆ serverForNewObjects

CesiumIonServer CesiumForUnity.CesiumIonServer.serverForNewObjects
staticgetset

Gets the current Cesium ion server that should be assigned to newly-created objects.

Definition at line 120 of file CesiumIonServer.cs.


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