Class ABRLegend

Generate geometry, encodings, and legend images/GameObjects for ABR states

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
ABRLegend
Namespace: IVLab.ABREngine.Legends
Assembly: IVLab.ABREngine.Runtime.dll
Syntax
public class ABRLegend : MonoBehaviour

Fields

| Improve this Doc View Source

entryOffset

Generate geometry, encodings, and legend images/GameObjects for ABR states

Declaration
[Tooltip("Offset for each entry of the legend")]
public Vector3 entryOffset
Field Value
Type Description
Vector3
| Improve this Doc View Source

legendEntry2DPrefab

Generate geometry, encodings, and legend images/GameObjects for ABR states

Declaration
[Tooltip("Prefab for 2D (2 variable) legend entries")]
public GameObject legendEntry2DPrefab
Field Value
Type Description
GameObject
| Improve this Doc View Source

updateOnABRStateChange

Generate geometry, encodings, and legend images/GameObjects for ABR states

Declaration
[Tooltip("Should the legend be updated whenever the ABR state is updated?")]
public bool updateOnABRStateChange
Field Value
Type Description
bool

Methods

| Improve this Doc View Source

CreateGlyphLegendEntry(SimpleGlyphDataImpression)

Construct a glyph data impression for a glyph legend entry

Declaration
public static SimpleGlyphDataImpression CreateGlyphLegendEntry(SimpleGlyphDataImpression i)
Parameters
Type Name Description
SimpleGlyphDataImpression i
Returns
Type Description
SimpleGlyphDataImpression
| Improve this Doc View Source

CreateRibbonLegendEntry(SimpleLineDataImpression)

Construct a ribbon data impression for a line legend entry

Declaration
public static SimpleLineDataImpression CreateRibbonLegendEntry(SimpleLineDataImpression i)
Parameters
Type Name Description
SimpleLineDataImpression i
Returns
Type Description
SimpleLineDataImpression
| Improve this Doc View Source

CreateSurfaceLegendEntry(SimpleSurfaceDataImpression)

Construct a surface data impression for legend entry

Declaration
public static SimpleSurfaceDataImpression CreateSurfaceLegendEntry(SimpleSurfaceDataImpression i)
Parameters
Type Name Description
SimpleSurfaceDataImpression i
Returns
Type Description
SimpleSurfaceDataImpression
| Improve this Doc View Source

CreateVolumeLegendEntry(SimpleVolumeDataImpression)

Construct a volume data impression for legend entry

Declaration
public static SimpleVolumeDataImpression CreateVolumeLegendEntry(SimpleVolumeDataImpression i)
Parameters
Type Name Description
SimpleVolumeDataImpression i
Returns
Type Description
SimpleVolumeDataImpression
| Improve this Doc View Source

UpdateLegend(JObject)

Update the legend display in Unity from the current ABR state

Declaration
public void UpdateLegend(JObject state)
Parameters
Type Name Description
JObject state