egui

README

Docs: GoDoc

egui handles all the GUI elements for a typical simulation, reducing boilerplate code in models.

Documentation

Index

• Variables
• type GUI
  • func (gui *GUI) AddActRFGridTabs(arfs *actrf.RFs)
  • func (gui *GUI) AddPlots(title string, lg *elog.Logs)
  • func (gui *GUI) AddToolbarItem(item ToolbarItem)
  • func (gui *GUI) ConfigRasterGrid(lay *gi.Layout, laynm string, rast *etensor.Float32) *etview.TensorGrid
  • func (gui *GUI) FinalizeGUI(closePrompt bool)
  • func (gui *GUI) Grid(name string) *etview.TensorGrid
  • func (gui *GUI) InitNetData(net emer.Network, nrecs int)
  • func (gui *GUI) MakeWindow(sim interface{}, appname, title, about string)
  • func (gui *GUI) NetDataRecord()
  • func (gui *GUI) Plot(mode elog.EvalModes, time elog.Times) *eplot.Plot2D
  • func (gui *GUI) PlotScope(scope elog.ScopeKey) *eplot.Plot2D
  • func (gui *GUI) SaveActRFGrid(tg *etview.TensorGrid, name string)
  • func (gui *GUI) SaveNetData(extra string)
  • func (gui *GUI) SetGrid(name string, tg *etview.TensorGrid)
  • func (gui *GUI) SetPlot(scope elog.ScopeKey, plt *eplot.Plot2D)
  • func (gui *GUI) Stopped()
  • func (gui *GUI) UpdateCyclePlot(mode elog.EvalModes, cycle int) *eplot.Plot2D
  • func (gui *GUI) UpdateNetView()
  • func (gui *GUI) UpdatePlot(mode elog.EvalModes, time elog.Times) *eplot.Plot2D
  • func (gui *GUI) UpdatePlotScope(scope elog.ScopeKey) *eplot.Plot2D
  • func (gui *GUI) UpdateWindow()
  • func (gui *GUI) ViewActRFs(atf *actrf.RFs)
• type ToolGhosting
  • func (ev ToolGhosting) MarshalJSON() ([]byte, error)
  • func (ev *ToolGhosting) UnmarshalJSON(b []byte) error
• type ToolbarItem

Variables

var KiT_ToolGhosting = kit.Enums.AddEnum(ToolGhostingN, kit.BitFlag, nil)

Types

type GUI

type GUI struct {
	NetViewText         string `desc:"text to display at bottom of the NetView -- has relevant network state"`
	CycleUpdateInterval int    `desc:"how many cycles between updates of cycle-level plots"`
	Active              bool   `view:"-" desc:"true if the GUI is configured and running"`
	IsRunning           bool   `view:"-" desc:"true if sim is running"`
	StopNow             bool   `view:"-" desc:"flag to stop running"`

	Plots map[elog.ScopeKey]*eplot.Plot2D `desc:"plots by scope"`
	Grids map[string]*etview.TensorGrid   `desc:"tensor grid views by name -- used e.g., for Rasters or ActRFs -- use Grid(name) to access"`

	NetView    *netview.NetView `view:"-" desc:"the network viewer"`
	NetData    *netview.NetData `view:"-" desc:"net data for recording in nogui mode, if !nil"`
	ToolBar    *gi.ToolBar      `view:"-" desc:"the master toolbar"`
	StructView *giv.StructView  `view:"-" desc:"displays Sim fields on left"`
	TabView    *gi.TabView      `view:"-" desc:"tabs for different view elements: plots, rasters"`
	Win        *gi.Window       `view:"-" desc:"main GUI gui.Window"`
	ViewPort   *gi.Viewport2D   `view:"-" desc:"main viewport for Window"`
}

GUI manages all standard elements of a simulation Graphical User Interface

func (*GUI) AddActRFGridTabs

func (gui *GUI) AddActRFGridTabs(arfs *actrf.RFs)

AddActRFGridTabs adds tabs for each of the ActRFs.

func (*GUI) AddPlots

func (gui *GUI) AddPlots(title string, lg *elog.Logs)

AddPlots adds plots based on the unique tables we have, currently assumes they should always be plotted

func (*GUI) AddToolbarItem

func (gui *GUI) AddToolbarItem(item ToolbarItem)

AddToolbarItem adds a toolbar item but also checks when it be active in the UI

func (*GUI) ConfigRasterGrid

func (gui *GUI) ConfigRasterGrid(lay *gi.Layout, laynm string, rast *etensor.Float32) *etview.TensorGrid

ConfigRasterGrid configures a raster grid for given layer name. Uses Raster_laynm and given Tensor that has the raster data.

func (*GUI) FinalizeGUI

func (gui *GUI) FinalizeGUI(closePrompt bool)

FinalizeGUI wraps the end functionality of the GUI

func (*GUI) Grid

func (gui *GUI) Grid(name string) *etview.TensorGrid

Grid gets tensor grid view of given name, creating if not yet made

func (*GUI) InitNetData

func (gui *GUI) InitNetData(net emer.Network, nrecs int)

InitNetData initializes the NetData object to record NetView data when the GUI is not active (located in egui package because of the NetViewText that is also recorded)

func (*GUI) MakeWindow

func (gui *GUI) MakeWindow(sim interface{}, appname, title, about string)

MakeWindow specifies default window settings that are largely used in all windwos

func (*GUI) NetDataRecord

func (gui *GUI) NetDataRecord()

NetDataRecord records current netview data if InitNetData has been called and NetData exists.

func (*GUI) Plot

func (gui *GUI) Plot(mode elog.EvalModes, time elog.Times) *eplot.Plot2D

Plot returns plot for mode, time scope

func (*GUI) PlotScope

func (gui *GUI) PlotScope(scope elog.ScopeKey) *eplot.Plot2D

PlotScope returns plot for given scope

func (*GUI) SaveActRFGrid

func (gui *GUI) SaveActRFGrid(tg *etview.TensorGrid, name string)

SaveActRFGrid stores the given TensorGrid in Grids under given name, and configures the grid view for ActRF viewing.

func (*GUI) SaveNetData

func (gui *GUI) SaveNetData(extra string)

SaveNetData saves NetData NetView data (if !nil) to a file named by the network name plus _extra name plus ".netdata.gz"

func (*GUI) SetGrid

func (gui *GUI) SetGrid(name string, tg *etview.TensorGrid)

SetGrid sets tensor grid view to given name

func (*GUI) SetPlot

func (gui *GUI) SetPlot(scope elog.ScopeKey, plt *eplot.Plot2D)

SetPlot stores given plot in Plots map

func (*GUI) Stopped

func (gui *GUI) Stopped()

Stopped is called when a run method stops running -- updates the IsRunning flag and toolbar

func (*GUI) UpdateCyclePlot

func (gui *GUI) UpdateCyclePlot(mode elog.EvalModes, cycle int) *eplot.Plot2D

UpdateCyclePlot updates cycle plot for given mode. only updates every CycleUpdateInterval

func (*GUI) UpdateNetView

func (gui *GUI) UpdateNetView()

UpdateNetView updates the gui visualization of the network set the NetViewText field prior to updating

func (*GUI) UpdatePlot

func (gui *GUI) UpdatePlot(mode elog.EvalModes, time elog.Times) *eplot.Plot2D

UpdatePlot updates plot for given mode, time scope

func (*GUI) UpdatePlotScope

func (gui *GUI) UpdatePlotScope(scope elog.ScopeKey) *eplot.Plot2D

UpdatePlotScope updates plot at given scope

func (*GUI) UpdateWindow

func (gui *GUI) UpdateWindow()

UpdateWindow renders the viewport associated with the main window

func (*GUI) ViewActRFs

func (gui *GUI) ViewActRFs(atf *actrf.RFs)

ViewActRFs displays act rfs into tensor Grid views previously configured

type ToolGhosting

type ToolGhosting int32

ToolGhosting the mode enum

const (
	ActiveStopped ToolGhosting = iota

	ActiveRunning

	ActiveAlways

	ToolGhostingN
)

The evaluation modes for when a tool bar can be clicked

func (ToolGhosting) MarshalJSON

func (ev ToolGhosting) MarshalJSON() ([]byte, error)

func (*ToolGhosting) UnmarshalJSON

func (ev *ToolGhosting) UnmarshalJSON(b []byte) error

type ToolbarItem

type ToolbarItem struct {
	Label   string
	Icon    string
	Tooltip string
	Active  ToolGhosting
	Func    func()
}

ToolbarItem holds the configuration values for a toolbar item