eidolon.VisualizerUI Namespace Reference

Classes
class	Base2DWidget
class	BaseSpectrumWidget
class	ConsoleWidget
class	Draw2DView
class	GPUProgramPropertyWidget
class	JupyterWidget
class	LightPropertyWidget
class	LogFileView
class	MaterialPropertyWidget
class	ObjectPropertyWidget
class	ObjectReprPropertyWidget
class	ParamPanel
class	ProjectPropertyWidget
class	RenderWidget
class	ScreenshotDialog
class	ShowMessageDialog
class	TextBoxDialog
class	VisualizerWindow
class	VizDockWidget

Functions
def	initUI (args=None)
def	getUIApp ()
def	execUI (doExit=True)
def	createVizWin (conf, width, height)
def	getVizWin ()
def	cppdel (obj)
def	toQtColor (c)
def	traverseWidget (widg, func=lambda i:True)
def	signalBlocker (objs)
def	getWheelXY (qwheelevent)
def	getWheelDelta (qwheelevent)
def	validQVariant (qvar)
def	validQVariantStr (qvar)
def	selectBoxIndex (val, box)
def	setCollapsibleGroupbox (box, isVisible=True)
def	setWarningStylesheet (widg)
def	centerWindow (wind)
def	resizeScreenRelative (wind, w, h)
def	screenshotWidget (w, filename)
def	setChecked (isChecked, checkbox)
def	setColorButton (col, button)
def	setSpinBox (box, minval=None, maxval=None, stepval=None, decimals=None)
def	currentIndexDataStr (obj)
def	fillEnumTable (vals, table, numsSelectable=False)
def	setTableHeaders (table)
def	fillTable (vals, table)
def	fillList (listobj, items, curitem=-1, defaultitem=None, checkChanges=False)
def	createSplitWidget (parent, widg1, widg2, isVertical=True)
def	createMenu (title, values, defaultFunc=lambda v:None, parent=None)
def	mapWidgetValues (widget)
def	setWidgetValues (widget, vals)
def	addCustomUIRow (layout, index, uitype, name, labelText, minval=0, maxval=0, stepval=1, decimals=6)
def	signalmethod (meth)
def	signalclass (cls)

Variables
	jConsolePresent
	QtInProcessRichJupyterWidget
	globalApp
	globalWin
	CustomUIType
string	doc = 'Types of UI elements that can be made using custom UI generation routines'
	AssetType
	IconName
	mainTitleString
	method_signalmap

Function Documentation

addCustomUIRow()

def eidolon.VisualizerUI.addCustomUIRow	(		layout,
			index,
			uitype,
			name,
			labelText,
			minval = 0,
			maxval = 0,
			stepval = 1,
			decimals = 6
	)

Here is the call graph for this function:

Here is the caller graph for this function:

centerWindow()

def eidolon.VisualizerUI.centerWindow

(

wind

)

Centers the window `wind' on the desktop by moving it only.

Here is the caller graph for this function:

cppdel()

def eidolon.VisualizerUI.cppdel

(

obj

)

Delete the Qt object; this is sip specific so would have be changed to use PySide.

Here is the caller graph for this function:

createMenu()

def eidolon.VisualizerUI.createMenu	(		title,
			values,
			defaultFunc = lambda v:None,
			parent = None
	)

Construct a menu widget from the given values. The list `values' must contain strings, pairs containing strings
and a callback function, '---' for a separator, or further lists thereof. When a item is selected, the given callback
function is called with the string passed as an argument, if only a string is given then `defaultFunc' is called
instead with that string as argument.

Here is the caller graph for this function:

createSplitWidget()

def eidolon.VisualizerUI.createSplitWidget	(		parent,
			widg1,
			widg2,
			isVertical = True
	)

Create a splitter widget within `parent' with `widg1' and `widg2' as its two halves, vertical if `isVertical.

createVizWin()

def eidolon.VisualizerUI.createVizWin	(		conf,
			width,
			height
	)

Create a visualization window and return it. This also initializes the global scene manager.

currentIndexDataStr()

def eidolon.VisualizerUI.currentIndexDataStr

(

obj

)

Returns the string form of the QVariant object at the current index in `obj', or the current text if that isn't valid.

Here is the call graph for this function:

Here is the caller graph for this function:

execUI()

def eidolon.VisualizerUI.execUI

(

doExit = True

)

Run the event loop and wait until all windows are closed. If doExit is true then exit is called
with the result, otherwise the result is returned by this function.

fillEnumTable()

def eidolon.VisualizerUI.fillEnumTable	(		vals,
			table,
			numsSelectable = False
	)

Here is the call graph for this function:

Here is the caller graph for this function:

fillList()

def eidolon.VisualizerUI.fillList	(		listobj,
			items,
			curitem = -1,
			defaultitem = None,
			checkChanges = False
	)

Fills the object `listobj' with the list `items'. The object `listobj' must be a QComboBox or QListWidget. Values
in `items' may be single strings or (item,value) string pairs; when adding each item to a QComboBox, the string is
used as the `userData' value in addItem in the first case but the given value part of the pair in the second case.
If `curitem' is left as -1, the QComboBox object's current item will not be changed if it's present in the new list
of items. If `curitem' is a string then the current index for either object type is set to select that member of the
list, if a valid index value then that index is instead selected, otherwise no item is selected. if `defaultitem'
is a non-empty string, this is added as the first member of the list. If `checkChanges' is True, the contents of
`listobj' are compared to `items' and is only refilled if they differ; the expense of this operation versus refilling
the list are up to the caller to determine.

Here is the call graph for this function:

Here is the caller graph for this function:

fillTable()

def eidolon.VisualizerUI.fillTable	(		vals,
			table
	)

Here is the call graph for this function:

Here is the caller graph for this function:

getUIApp()

def eidolon.VisualizerUI.getUIApp

(

)

getVizWin()

def eidolon.VisualizerUI.getVizWin

(

)

get the visualization window after it has been created.

getWheelDelta()

def eidolon.VisualizerUI.getWheelDelta

(

qwheelevent

)

Returns a wheel scroll delta value combining the X and Y axes.

Here is the call graph for this function:

Here is the caller graph for this function:

getWheelXY()

def eidolon.VisualizerUI.getWheelXY

(

qwheelevent

)

PyQt4/5 compatibility wrapper around the QWheelEvent wheel scroll angle, returns the (X,Y) scroll values.

Here is the caller graph for this function:

initUI()

def eidolon.VisualizerUI.initUI

(

args = None

)

Initialize the UI framework.

mapWidgetValues()

def eidolon.VisualizerUI.mapWidgetValues

(

widget

)

Here is the caller graph for this function:

resizeScreenRelative()

def eidolon.VisualizerUI.resizeScreenRelative	(		wind,
			w,
			h
	)

screenshotWidget()

def eidolon.VisualizerUI.screenshotWidget	(		w,
			filename
	)

Save a screenshot of the widget `w' to the file `filename'.

Here is the caller graph for this function:

selectBoxIndex()

def eidolon.VisualizerUI.selectBoxIndex	(		val,
			box
	)

Set the current index in `box' to be the first item whose text is `val', returning True if this was done.

Here is the call graph for this function:

Here is the caller graph for this function:

setChecked()

def eidolon.VisualizerUI.setChecked	(		isChecked,
			checkbox
	)

Set the checkable widget `checkbox' to the boolean status `isChecked'.

Here is the call graph for this function:

Here is the caller graph for this function:

setCollapsibleGroupbox()

def eidolon.VisualizerUI.setCollapsibleGroupbox	(		box,
			isVisible = True
	)

Transforms the QGroupBox `box' into a collapsible one, which will have a check box that collapses its contents if
unchecked. The box will be initially collapsed if `isVisible' is False.

Here is the caller graph for this function:

setColorButton()

def eidolon.VisualizerUI.setColorButton	(		col,
			button
	)

Set the colour of left hand border of `button' to color object `col'.

Here is the call graph for this function:

Here is the caller graph for this function:

setSpinBox()

def eidolon.VisualizerUI.setSpinBox	(		box,
			minval = None,
			maxval = None,
			stepval = None,
			decimals = None
	)

Here is the call graph for this function:

Here is the caller graph for this function:

setTableHeaders()

def eidolon.VisualizerUI.setTableHeaders

(

table

)

Here is the caller graph for this function:

setWarningStylesheet()

def eidolon.VisualizerUI.setWarningStylesheet

(

widg

)

Set the stylesheet for `widg' to show a black+yellow striped background indicating advanced/dangerous features.

setWidgetValues()

def eidolon.VisualizerUI.setWidgetValues	(		widget,
			vals
	)

Here is the call graph for this function:

signalBlocker()

def eidolon.VisualizerUI.signalBlocker

(

objs

)

This context manager blocks signals going to the given argument objects within the scope of a 'with' code block.

Here is the caller graph for this function:

signalclass()

def eidolon.VisualizerUI.signalclass

(

cls

)

Class decorator for implementing the method signal proxy interface. It collects all the methods annotated with @signalmethod
and stores them in a map keyed to their names, and sets the member to the proxy method which sends the corresponding signal.
Whenever a signal with the name of the method is received, the original method annotated with @signalmethod is called.
For example, a method 'foo' with the annotation will be replaces with a proxy emiting a signal with the name 'foo' to the
self.method_signal member, which is connected to a method that will extract 'foo' from self.method_signalmap and call it.
The purpose of this is to cause methods of UI classes to be executed within the main UI thread when called from other threads.
The caller does not block waiting for a result from the call.

signalmethod()

def eidolon.VisualizerUI.signalmethod

(

meth

)

Method decorator for turning a method into a signal proxy. This causes the method to become asynchronous.

toQtColor()

def eidolon.VisualizerUI.toQtColor

(

c

)

Converts an iterable object yielding color channel unit float values to a QColor.

Here is the caller graph for this function:

traverseWidget()

def eidolon.VisualizerUI.traverseWidget	(		widg,
			func = lambda i:True
	)

validQVariant()

def eidolon.VisualizerUI.validQVariant

(

qvar

)

Returns True if the value `qvar' is a valid QVariant object in PyQt4 or if it is not None in PyQt5.

Here is the caller graph for this function:

validQVariantStr()

def eidolon.VisualizerUI.validQVariantStr

(

qvar

)

In PyQt4 returns the string contents of the QVariant `qvar' if valid. In PyQt5 returns the string representation of
`qvar' (which can be anything) or empty string if it is None.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

AssetType

AssetType

CustomUIType

CustomUIType

doc

string doc = 'Types of UI elements that can be made using custom UI generation routines'

globalApp

globalApp

globalWin

globalWin

IconName

IconName

jConsolePresent

jConsolePresent

mainTitleString

mainTitleString

method_signalmap

method_signalmap

QtInProcessRichJupyterWidget

QtInProcessRichJupyterWidget