Class ABRConfig

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Inheritance

object

Object

ScriptableObject

ABRConfig

Namespace: IVLab.ABREngine

Assembly: IVLab.ABREngine.Runtime.dll

Syntax

[CreateAssetMenu(fileName = "ABRConfig", menuName = "ABR/ABR Configuration")]
public class ABRConfig : ScriptableObject

Fields

dataServerUrl

What server to obtain data from, if any. If none provided, ABR will assume that everything is in Unity's persistentData path. If server is provided and resource doesn't exist in persistentData, it will be downloaded. Default: null

Declaration

[Tooltip("Server to load VisAssets from (e.g. `http://192.168.137.1:8001/api`")]
public string dataServerUrl

Field Value

Type	Description
string

defaultColor

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Tooltip("Default color for geometries that have not had a colormap applied yet")]
public Color defaultColor

Field Value

Type	Description
Color

defaultDataContainer

Default bounds for datasets when showing (in Unity world coordinates)

Declaration

[Tooltip("Unity world-space container to automatically 'squish' all data into to avoid overflowing Unity coordinates")]
public Bounds defaultDataContainer

Field Value

Type	Description
Bounds

defaultGlyph

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Header("Styling Defaults")]
[Tooltip("Default shape/color for glyphs in the Glyph layer")]
public GameObject defaultGlyph

Field Value

Type	Description
GameObject

defaultNanColor

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Tooltip("Default color for NaN values")]
public Color defaultNanColor

Field Value

Type	Description
Color

defaultNanLine

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Tooltip("Default line texture for NaN values on ribbons")]
public Texture2D defaultNanLine

Field Value

Type	Description
Texture2D

defaultNanTexture

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Tooltip("Default texture for NaN values on surfaces")]
public Texture2D defaultNanTexture

Field Value

Type	Description
Texture2D

loadStateOnStart

Load a state from resources on ABREngine startup

Declaration

[Tooltip("Load a state from Resources or StreamingAssets folder on ABREngine startup. Example: `testState.json` Leave blank for no startup state.")]
public string loadStateOnStart

Field Value

Type	Description
string

mediaPath

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Header("Common Configuration Options (hover for more info)")]
[Tooltip("Location on this computer where VisAssets and Datasets are located. Relative paths (e.g. `../media`) are also acceptable.")]
public string mediaPath

Field Value

Type	Description
string

persistBetweenScenes

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Tooltip("Should the ABREngine GameObject persist between scenes?")]
public bool persistBetweenScenes

Field Value

Type	Description
bool

schemaName

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Header("ABR Schema Configuration")]
[Tooltip("Name of the schema to use in ABRSchemas~ folder at root of this package")]
public string schemaName

Field Value

Type	Description
string

serverUrl

What server to connect to, if any. If provided, ABR will try to register with the server immediately upon startup. Default: null

Declaration

[Tooltip("Full URL of the ABR server / visualization manager that this app should connect to. Leave blank for no server.")]
public string serverUrl

Field Value

Type	Description
string

startServer

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Tooltip("Should the ABREngine try to start the ABRServer when it is started? Use this option with caution. In most cases the ABR Server should be started externally.")]
public bool startServer

Field Value

Type	Description
bool

useAutoDataContainers

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Header("Data Container Options")]
[Tooltip("Use the automatic data containers (defined in-scene with ABRDataBounds or the defaultDataBounds), or just import coordinates as-is")]
public bool useAutoDataContainers

Field Value

Type	Description
bool

visAssetServerUrl

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

[Header("Network-Based VisAssets and Data Configuration")]
[Tooltip("Server to load VisAssets from (e.g. `http://192.168.137.1:8000/media/visassets`")]
public string visAssetServerUrl

Field Value

Type	Description
string

Properties

DefaultCamera

Camera to use as ABR's main camera. If left blank, will assume @Camera.main.

Declaration

public Camera DefaultCamera { get; set; }

Property Value

Type	Description
Camera

Schema

The Json Schema to use for validation of ABR states

Declaration

public JSchema Schema { get; }

Property Value

Type	Description
JSchema

SchemaJson

Schema to use for internally grabbing default values

Declaration

public JObject SchemaJson { get; }

Property Value

Type	Description
JObject

ServerUrl

Actual URI-ified URL of the server that ABR should connect to

Declaration

public Uri ServerUrl { get; }

Property Value

Type	Description
Uri

Methods

GetDefaultRawABRInput(string, string)

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

public RawABRInput GetDefaultRawABRInput(string plateName, string inputName)

Parameters

Type	Name	Description
string	plateName
string	inputName

Returns

Type	Description
RawABRInput

GetInputNames(string)

Obtain a full list of all inputs available to this plate

Declaration

public string[] GetInputNames(string plateName)

Parameters

Type	Name	Description
string	plateName

Returns

Type	Description
string[]

GetInputValueDefault<T>(string, string)

Get the default primitive value for a particular data impression's parameter

Declaration

public T GetInputValueDefault<T>(string plateName, string inputName) where T : IPrimitive

Parameters

Type	Name	Description
string	plateName
string	inputName

Returns

Type	Description
T

Type Parameters

Name	Description
T

LoadSchema()

This Scriptable Object controls the ABR configuration before startup. On engine startup, a copy is instantiated for use at runtime.

Declaration

public void LoadSchema()

ToString()

Returns the name of the object.

Declaration

public override string ToString()

Returns

Type	Description
string	The name returned by ToString.

Overrides

UnityEngine.Object.ToString()