ost::gui Namespace Reference

Namespaces
	dng
	gosty_startup
	helpwidget
	init_context_menu
	init_menubar
	init_spacenav
	init_splash
	scene
	table
	trajectory_viewer

Data Structures
class	AdminRights
class	DockWidget
class	FileBrowser
class	FileLoader
class	FileTypeDialog
class	FileViewer
class	GLCanvas
class	GLWin
class	GostyApp
class	GostyMainWindow
class	MainArea
class	MainWindow
class	LogReader
class	MessageLevel
class	MessageBoxWidget
class	MessageWidget
class	BottomBar
class	ButtonBar
class	ButtonBox
class	DropBox
class	EventButton
struct	WidgetState
class	PanelBar
class	PanelBarWidgetHolder
class	PanelManager
class	PanelWidgetContainer
class	SideBar
class	SplitterPanelBar
class	DragTabBar
class	TabbedDragWidget
class	TabbedPanelBar
class	Perspective
class	OstCompleterBase
class	OstDirModel
class	Gutter
class	MainThreadRunner
class	OutputRedirector
class	PathCompleter
class	PythonCompleter
class	PythonContext
class	PythonContextParser
class	PythonInterpreter
class	PythonInterpreterWorker
class	PythonShell
struct	GutterBlock
class	PythonShellTextDocumentLayout
class	PythonShellWidget
class	PythonSyntaxHighlighter
struct	Range
class	PythonToken
class	PythonTokenizer
class	ShellHistory
class	State
class	StateMachine
class	TextLogger
class	TransitionBase
class	AutomaticTransition
class	SignalTransition
class	KeyEventTransition
class	MouseEventTransition
class	TransitionGuard
class	HistoryGuard
class	EditPositionGuard
class	BlockStatusGuard
class	SceneMenu
class	SceneSelection
class	ContextMenu
class	CurrentSelectionNode
class	CustomPartNode
class	EntityNode
class	EntityPartNode
class	GfxSceneNode
class	LabelNode
class	RenderModeNode
class	RenderModesNode
class	RootNode
class	SceneNode
class	SceneWin
class	SceneWinModel
class	AlignPropertiesPainter
class	AlignmentViewObject
class	BackgroundPainter
class	BaseRow
class	BaseViewObject
class	ConservationPainter
class	Painter
class	SecStrRow
class	SeqSecStrPainter
class	SeqSelectionPainter
class	SeqTextPainter
class	SequenceDelegate
class	SequenceModel
class	SequenceRow
class	SeqSearchBar
class	SequenceTableView
class	SequenceViewObject
class	SequenceViewer
class	TickPainter
class	TitleRow
class	ThinSplitter
class	Manipulator
class	MapTool
class	Measurement
class	MeasureTool
class	MouseEvent
class	SelectionTool
class	Tool
class	ToolBar
class	ToolManager
class	ToolOption
class	ToolOptionNum
class	ToolOptionEnum
class	ToolOptionButton
class	ToolOptionGroup
class	ToolOptions
class	EnumOptBinder
class	IntOptBinder
class	FloatOptBinder
class	ToolOptionsWidget
class	ToolOptionsWin
class	Widget
class	WidgetGeomHandler
struct	PooledWidget
class	WidgetPool
class	WidgetFactory
class	WidgetRegistry
class	WidgetStateSaverConfig
class	WidgetStateSaver
class	WidgetStateSaver< BASE, T1, T2 >
class	WidgetStateSaver< BASE, T1 >
class	WidgetStateSaver< BASE >
class	OneOf
class	TwoOf
class	ManyOf

Typedefs
typedef std::vector< GutterBlock >	GutterBlockList
typedef QList< SceneNode * >	SceneNodeList
typedef QList< BaseRow * >	BaseRowList
typedef QList< Painter * >	PainterList
typedef boost::shared_ptr < Manipulator >	ManipulatorPtr
typedef std::vector< Measurement >	MeasurementList
typedef std::vector< Tool * >	ToolList
typedef ToolOptionNum< int, ToolOption::INT >	ToolOptionInt
typedef ToolOptionNum< float, ToolOption::FLOAT >	ToolOptionFloat
typedef std::vector< ToolOption * >	ToolOptionList
typedef std::vector < ToolOptionGroup * >	ToolOptionGroups
typedef QList< QAction * >	ActionList

Enumerations
enum	PanelPosition { LEFT_PANEL = 0, RIGHT_PANEL, BOTTOM_PANEL, NONE }
enum	InterpreterStatus { STATUS_OK, STATUS_ERROR }
enum	CodeBlockStatus { CODE_BLOCK_COMPLETE =1, CODE_BLOCK_ERROR =2, CODE_BLOCK_INCOMPLETE =4 }
enum	BlockEditMode { EDITMODE_SINGLELINE, EDITMODE_MULTILINE_ACTIVE, EDITMODE_MULTILINE_INACTIVE }
enum	BlockType {   BLOCKTYPE_OUTPUT =1, BLOCKTYPE_ERROR =2, BLOCKTYPE_CODE =4, BLOCKTYPE_ACTIVE =8,   BLOCKTYPE_BLOCKEDIT =16, BLOCKTYPE_MULTILINE_SQ =32, BLOCKTYPE_MULTILINE_DQ =64 }
enum	ContextActionType {   GFX_NODE =0x1, GFX_OBJECT =0x2, ENTITY =0x4, ENTITY_VIEW =0x8,   CUSTOM_VIEW =0x10, NOT_VISIBLE =0x20, NOT_HIDDEN =0x40, NOT_SCENE =0x80,   SINGLE =0x100, MULTI =0x200, VIEWS_SAME_OBJECT =0x400, MAP =0x800,   MAP_ORIGINAL =0x1000, MAP_DOWNSAMPLED =0x2000, MAP_DSAMPLED_AVAIL =0x4000 }

Functions
def	CreateDataViewer
def	ClearMessageWidget
def	PickColor
def	GetMenu
def	AddMenuAction
def	PushVerbosityLevel
def	PopVerbosityLevel

Variables
	predicate
	action

Typedef Documentation

typedef QList<QAction*> ActionList

Definition at line 33 of file widget.hh.

typedef QList<BaseRow*> BaseRowList

Definition at line 75 of file base_row.hh.

typedef std::vector<GutterBlock> GutterBlockList

Definition at line 43 of file python_shell_widget.hh.

typedef boost::shared_ptr<Manipulator> ManipulatorPtr

Definition at line 35 of file manipulator.hh.

typedef std::vector<Measurement> MeasurementList

Definition at line 62 of file measure_tool.hh.

typedef QList<Painter*> PainterList

Definition at line 48 of file painter.hh.

typedef QList<SceneNode*> SceneNodeList

Definition at line 34 of file scene_node.hh.

typedef std::vector<Tool*> ToolList

Definition at line 33 of file tool_manager.hh.

typedef ToolOptionNum<float, ToolOption::FLOAT> ToolOptionFloat

Definition at line 90 of file tool_option.hh.

typedef std::vector<ToolOptionGroup*> ToolOptionGroups

Definition at line 54 of file tool_option_group.hh.

typedef ToolOptionNum<int, ToolOption::INT> ToolOptionInt

Definition at line 89 of file tool_option.hh.

typedef std::vector<ToolOption*> ToolOptionList

Definition at line 140 of file tool_option.hh.

Enumeration Type Documentation

enum BlockEditMode

Enumerator
EDITMODE_SINGLELINE
EDITMODE_MULTILINE_ACTIVE
EDITMODE_MULTILINE_INACTIVE

Definition at line 31 of file python_shell_fw.hh.

enum BlockType

Enumerator
BLOCKTYPE_OUTPUT
BLOCKTYPE_ERROR
BLOCKTYPE_CODE
BLOCKTYPE_ACTIVE
BLOCKTYPE_BLOCKEDIT
BLOCKTYPE_MULTILINE_SQ
BLOCKTYPE_MULTILINE_DQ

Definition at line 36 of file python_shell_fw.hh.

enum CodeBlockStatus

Enumerator
CODE_BLOCK_COMPLETE
CODE_BLOCK_ERROR
CODE_BLOCK_INCOMPLETE

Definition at line 48 of file python_interpreter.hh.

enum ContextActionType

Enumerator
GFX_NODE
GFX_OBJECT
ENTITY
ENTITY_VIEW
CUSTOM_VIEW
NOT_VISIBLE
NOT_HIDDEN
NOT_SCENE
SINGLE
MULTI
VIEWS_SAME_OBJECT
MAP
MAP_ORIGINAL
MAP_DOWNSAMPLED
MAP_DSAMPLED_AVAIL

Definition at line 36 of file context_menu.hh.

enum InterpreterStatus

Enumerator
STATUS_OK
STATUS_ERROR

Definition at line 42 of file python_interpreter.hh.

enum PanelPosition

Enumerator
LEFT_PANEL
RIGHT_PANEL
BOTTOM_PANEL
NONE

Definition at line 37 of file panel_manager.hh.

Function Documentation

def ost.gui.AddMenuAction	(		args,
			kwargs
	)

Add menu action to main menu.

This function lets you conveniently add actions to the main menu. To add a new 
new action "Background Color" to the "Scene" menu, simply use

.. code-block:: python

  def SetBackgroundColor():
    scene.bg=gfx.PickColor(scene.bg)

  AddMenuAction('Scene', "Background Color", SetBackgroundColor)
  
This will add the menu "Scene" if it does not exist yet, register the action 
"Background Color" and execute the function SetBackgroundColor whenever the 
action is triggered.

To assign a keyboard shortcut to the action, you can use the shortcut 
argument:

.. code-block:: python

  AddMenuAction('Scene', 'Background Color', SetBackgroundColor,
                shortcut='Ctrl+B')

Whenever you press Ctrl+B (Cmd+B on macOS), the action will be executed.

Very often menu actions are coupled to the current selected objects in the 
scene menu. These menu actions are either enabled or disabled depending on the 
type of the selected objects. To easily support this scenario, the "enable" 
state of the menu action can be tightly coupled to the scene menu by providing 
a callable to the enabled argument. As an example, the following menu action 
is only enabled when exactly one gfx.Entity is selected.

.. code-block:: python

  AddMenuAction('Scene', 'PrintAtomCount', PrintAtomCount,
                enabled=OneOf(gfx.Entity))

OneOf is a simple function object that takes any number of classes and returns 
true when the selected object is an instance. Alterantively, you might want to 
use ManyOf or supply a custom function that evaluates the state of the menu 
action to suit your needs.

Definition at line 86 of file __init__.py.

def ost.gui.ClearMessageWidget

(

)

Definition at line 38 of file __init__.py.

def ost.gui.CreateDataViewer	(		ih,
			flag = False
	)

Definition at line 29 of file __init__.py.

def ost.gui.GetMenu	(		menu_name,
			create = False
	)

Definition at line 64 of file __init__.py.

def ost.gui.PickColor

(

default = gfx.WHITE

)

Pops up a color chooser that lets' the user pick a color and returns the 
selected color. If the user cancels the color chooser, None is returned.

:rtype: :class:`~ost.gfx.Color`

Definition at line 48 of file __init__.py.

def ost.gui.PopVerbosityLevel

(

)

Definition at line 232 of file __init__.py.

def ost.gui.PushVerbosityLevel

(

value

)

Definition at line 229 of file __init__.py.

Variable Documentation

action

Definition at line 135 of file __init__.py.

predicate

Definition at line 134 of file __init__.py.