A base class for activity settings which should be used to derive custom activity settings. More...

Public Member Functions
virtual void	Initialize ()
	Initializes the FAST.BaseSettings.activityId and FAST.AssetSettings.languages when creating an activity settings instance in code.

virtual void	Update ()
	Clears and reinitializes the FAST.BaseSettings.webRequestSettings, FAST.BaseSettings.udpConnectionSettings, and FAST.BaseSettings.serialConnectionSettings from all the FAST.WebRequests, FAST.UdpConnections, and FAST.SerialConnections in the activty.

Public Attributes
string	activityId = ""
	Settings, Code A unique name for the activity.

List< AlignmentTransformSettings >	alignmentSettings = new()
	Settings, Code The FAST.AlignmentTransformSettings and FAST.AlignmentRectTransformSettings for each FAST.AlignmentTransform and FAST.AlignmentRectTransform in the activity.

AssetSettings	assetSettings = new()
	Settings, Code The FAST.AssetSettings for the activity.

DisplaySettings	displaySettings = new()
	Settings, Code The FAST.DisplaySettings for the activity.

LogSettings	logSettings = new()
	Settings, Code The FAST.LogSettings for the activity.

List< SerialConnectionSettings >	serialConnectionSettings = new()
	Settings, Code The FAST.SerialConnectionSettings for each FAST.SerialConnection in the activity.

List< UdpConnectionSettings >	udpConnectionSettings = new()
	Settings, Code The FAST.UdpConnectionSettings for each FAST.UdpConnection in the activity.

List< WebRequestSettings >	webRequestSettings = new()
	Settings, Code The FAST.WebRequestSettings for each FAST.WebRequest in the activity.

WhiteScreenSettings	whiteScreenSettings = new()
	Settings, Code The FAST.WhiteScreenSettings for the activity.

Detailed Description

A base class for activity settings which should be used to derive custom activity settings.

Note: Derive from this class to create the activity settings for your Unity application.

See also: UnityEngine.Application.productName

Member Function Documentation

◆ Initialize()

virtual void Initialize ( )

virtual

Initializes the FAST.BaseSettings.activityId and FAST.AssetSettings.languages when creating an activity settings instance in code.

Called from FAST.SettingsLoader.ExecuteLoad() when an activity settings file is not found. Sets the FAST.BaseSettings.activityId to the UnityEngine.Application.productName and the FAST.AssetSettings.languages to the current operating system language.

◆ Update()

virtual void Update ( )

virtual

Clears and reinitializes the FAST.BaseSettings.webRequestSettings, FAST.BaseSettings.udpConnectionSettings, and FAST.BaseSettings.serialConnectionSettings from all the FAST.WebRequests, FAST.UdpConnections, and FAST.SerialConnections in the activty.

Called from Application.WriteSettings to make sure the settings are up-to-date before writing the XML file.

Member Data Documentation

◆ activityId

string activityId = ""

Settings, Code
A unique name for the activity.

Consider enumerating the name if there are multiple instances of the same activity. For example, "Activity1" or "Activity2".

◆ alignmentSettings

List<AlignmentTransformSettings> alignmentSettings = new()

Settings, Code
The FAST.AlignmentTransformSettings and FAST.AlignmentRectTransformSettings for each FAST.AlignmentTransform and FAST.AlignmentRectTransform in the activity.

◆ assetSettings

AssetSettings assetSettings = new()

Settings, Code
The FAST.AssetSettings for the activity.

◆ displaySettings

DisplaySettings displaySettings = new()

Settings, Code
The FAST.DisplaySettings for the activity.

◆ logSettings

LogSettings logSettings = new()

Settings, Code
The FAST.LogSettings for the activity.

◆ serialConnectionSettings

List<SerialConnectionSettings> serialConnectionSettings = new()

Settings, Code
The FAST.SerialConnectionSettings for each FAST.SerialConnection in the activity.

◆ udpConnectionSettings

List<UdpConnectionSettings> udpConnectionSettings = new()

Settings, Code
The FAST.UdpConnectionSettings for each FAST.UdpConnection in the activity.

◆ webRequestSettings

List<WebRequestSettings> webRequestSettings = new()

Settings, Code
The FAST.WebRequestSettings for each FAST.WebRequest in the activity.

◆ whiteScreenSettings

WhiteScreenSettings whiteScreenSettings = new()

Settings, Code
The FAST.WhiteScreenSettings for the activity.

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

C:/Users/cgbrown/Development/git/FAST/FAST-SDK/Runtime/Settings/BaseSettings.cs

Public Member Functions

Public Attributes