v_sim.UiRenderingWindow¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Box (14), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Orientable (2)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` (width, height, withFrame, withToolBar)
class	`new_withGlScene` (scene, withToolBar)
	`dump` (format, fileName, width, height)
	`getAccelGroup` ()
	`getDisplayCoordinatesInReduce` ()
	`getGlScene` ()
	`handleEvent` (ev)
	`loadFile` (data, iSet)
	`open` (parent)
	`popInteractive` (inter)
	`popMessage` ()
	`pushInteractive` (inter)
	`pushMessage` (message)
	`reload` ()
	`setDisplayCoordinatesInReduce` (status)

Virtual Methods¶

Inherited:: Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

Properties¶

Inherited:: Gtk.Box (3), Gtk.Container (3), Gtk.Widget (39), Gtk.Orientable (1)

Name	Type	Flags	Short Description
`coordinates-in-reduced`	`bool`	r/w	display node coordinates in reduced values
`data`	`v_sim.Data`	r/w	Data marks are applied to
`gl-scene`	`v_sim.GlNodeScene`	r/w/co	GlScene rendered in the window
`gl-view`	`v_sim.GlView`	r	GlView mark labels are aligned with
`interactive`	`v_sim.Interactive`	r	current interactive session
`label`	`str`	r	Label representing the data
`selection`	`v_sim.Node`	r	currently selected node, if any
`with-toolbar`	`bool`	w/co	if the widget has a toolbar or not

Child Properties¶

Inherited:: Gtk.Box (5)

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Short Description
`export`	Signal emitted when the user ask for data export.
`load-next-file`	Signal emitted when the user ask to load next file of a given list.
`load-prev-file`	Signal emitted when the user ask to load previous file of a given list.
`open`	Signal emitted when the user ask to open new data.
`reload`	Signal emitted when the user ask to reload current data.
`search`	Signal emitted when the user ask to search info in current data.
`show-action-dialog`	Signal emitted when the user ask to show the action dialog.
`show-main-panel`	Signal emitted when the user ask to raise the main panel.
`show-orientation-chooser`	Signal emitted when the user ask to precisely select a camera angle.

Fields¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Class Details¶

class v_sim.UiRenderingWindow(*args, **kwargs)¶

Bases:: Gtk.Box
Abstract:: No
Structure:: v_sim.UiRenderingWindowClass

Short form for a #VisuUiRenderingWindow_struct structure.

classmethod new(width, height, withFrame, withToolBar)¶

Parameters:

width (int) – its desired width ;
height (int) – its desired height ;
withFrame (bool) – a boolean ;
withToolBar (bool) – a boolean.

Returns:

a newly created v_sim.UiRenderingWindow widget.

Return type:

Gtk.Widget

A v_sim.UiRenderingWindow widget is a Gtk.Window that have an area for OpenGL drawing and a statusBar with many stuff like action buttons, real status bar for notifications, … The rendering area can be drawn with a frame or not. With this routine, only the v_sim.UiRenderingWindow widget is created.

classmethod new_withGlScene(scene, withToolBar)¶

Parameters:

scene (v_sim.GlNodeScene) – a v_sim.GlView object.
withToolBar (bool) – a boolean.

Returns:

a newly created v_sim.UiRenderingWindow widget.

Return type:

Gtk.Widget

Like v_sim.UiRenderingWindow.new(), but use an already existing view.

Added in version 3.8.

dump(format, fileName, width, height)¶

Parameters:

format (v_sim.Dump) – a v_sim.Dump object, corresponding to the write method ;
fileName (str) – a string that defined the file to write to ;
width (int) – an integer, or 0 for current ;
height (int) – an integer, or 0 for current ;

Call this method to dump the given self to a file. This is dumping the content of the rendering window. For offscreen rendering, see v_sim.GlExtSet.initOffscreenContext().

Added in version 3.9.

getAccelGroup()¶

Returns:: the Gtk.AccelGroup object of self.
Return type:: Gtk.AccelGroup

Retrieve the accelerator group of self.

Added in version 3.7.

getDisplayCoordinatesInReduce()¶

Returns:: True if the coordinates are displayed in reduced values.
Return type:: bool

Picked nodes have their coordinates displayed in the status bar of the rendering window. This methods retrieves if they are printed in reduced values or not.

Added in version 3.6.

getGlScene()¶

Returns:: the v_sim.GlNodeScene attached to the self or None on error.
Return type:: v_sim.GlNodeScene

This method is used to get the v_sim.GlExtSet attached to the rendering window.

Added in version 3.8.

handleEvent(ev)¶

Parameters:: ev (v_sim.SimplifiedEvents) – a v_sim.SimplifiedEvents object.

Handle the event, setting internally the OpenGL context properly. Do nothing if there is no interactive session running for self. See v_sim.UiRenderingWindow.pushInteractive().

Added in version 3.9.

loadFile(data, iSet)¶

Parameters:

data (v_sim.DataLoadable or None) – the v_sim.Data to be loaded.
iSet (int) – the id of data to load.

This method calls the general function to load data from file and deals with errors with gtkDialogs. The filenames must have already been set into data using visu_data_addFile().

open(parent)¶

Parameters:: parent (Gtk.Window or None) – the parent window for the filechooser dialog.

Do as if the load button has been pushed, i.e. open a filechooser dialog on the parent window, and load the resulting file, refreshing the view if necessary.

popInteractive(inter)¶

Parameters:: inter (v_sim.Interactive) – a v_sim.Interactive object.

It removes inter from the stack of interactive sessions currently attached to self. If inter was first on the stack, the next session is launched.

Added in version 3.6.

popMessage()¶: Remove the last message.

pushInteractive(inter)¶

Parameters:: inter (v_sim.Interactive) – a v_sim.Interactive object.

It adds inter to the stack of interactive sessions currently attached to self and launch it.

Added in version 3.6.

pushMessage(message)¶

Parameters:: message (str) – an UTF8 string to print on the status bar.

Use this method to add some informations on the status bar.

reload()¶: This routines reloads the current v_sim.Data object by rereading it on disk. If there is no current v_sim.Data object, it reports an error.

Added in version 3.7.

setDisplayCoordinatesInReduce(status)¶

Parameters:: status (bool) – a boolean.
Returns:: True if the value has been changed.
Return type:: bool

If set, the coordinates of picked nodes are displayed in reduced values.

Added in version 3.6.

Signal Details¶

v_sim.UiRenderingWindow.signals.export(ui_rendering_window)¶

Signal Name:: export
Flags:: RUN_LAST, ACTION
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask for data export.

Added in version 3.6.

v_sim.UiRenderingWindow.signals.load_next_file(ui_rendering_window)¶

Signal Name:: load-next-file
Flags:: RUN_LAST, NO_RECURSE, ACTION, NO_HOOKS
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask to load next file of a given list.

Added in version 3.7.

v_sim.UiRenderingWindow.signals.load_prev_file(ui_rendering_window)¶

Signal Name:: load-prev-file
Flags:: RUN_LAST, NO_RECURSE, ACTION, NO_HOOKS
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask to load previous file of a given list.

Added in version 3.7.

v_sim.UiRenderingWindow.signals.open(ui_rendering_window)¶

Signal Name:: open
Flags:: RUN_LAST, ACTION
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask to open new data.

Added in version 3.6.

v_sim.UiRenderingWindow.signals.reload(ui_rendering_window)¶

Signal Name:: reload
Flags:: RUN_LAST, ACTION
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask to reload current data.

Added in version 3.6.

v_sim.UiRenderingWindow.signals.search(ui_rendering_window)¶

Signal Name:: search
Flags:: RUN_LAST, ACTION
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask to search info in current data.

Added in version 3.7.

v_sim.UiRenderingWindow.signals.show_action_dialog(ui_rendering_window)¶

Signal Name:: show-action-dialog
Flags:: RUN_LAST, NO_RECURSE, ACTION, NO_HOOKS
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask to show the action dialog.

Added in version 3.6.

v_sim.UiRenderingWindow.signals.show_main_panel(ui_rendering_window)¶

Signal Name:: show-main-panel
Flags:: RUN_LAST, NO_RECURSE, ACTION, NO_HOOKS
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask to raise the main panel.

Added in version 3.6.

v_sim.UiRenderingWindow.signals.show_orientation_chooser(ui_rendering_window)¶

Signal Name:: show-orientation-chooser
Flags:: RUN_LAST, ACTION
Parameters:: ui_rendering_window (v_sim.UiRenderingWindow) – The object which received the signal

Signal emitted when the user ask to precisely select a camera angle.

Added in version 3.7.

Property Details¶

v_sim.UiRenderingWindow.props.coordinates_in_reduced¶

Name:: coordinates-in-reduced
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

display node coordinates in reduced values

v_sim.UiRenderingWindow.props.data¶

Name:: data
Type:: v_sim.Data
Default Value:: None
Flags:: READABLE, WRITABLE

Data marks are applied to

v_sim.UiRenderingWindow.props.gl_scene¶

Name:: gl-scene
Type:: v_sim.GlNodeScene
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

GlScene rendered in the window

v_sim.UiRenderingWindow.props.gl_view¶

Name:: gl-view
Type:: v_sim.GlView
Default Value:: None
Flags:: READABLE

GlView mark labels are aligned with

v_sim.UiRenderingWindow.props.interactive¶

Name:: interactive
Type:: v_sim.Interactive
Default Value:: None
Flags:: READABLE

current interactive session

v_sim.UiRenderingWindow.props.label¶

Name:: label
Type:: str
Default Value:: ''
Flags:: READABLE

Label representing the data

v_sim.UiRenderingWindow.props.selection¶

Name:: selection
Type:: v_sim.Node
Default Value:: None
Flags:: READABLE

currently selected node, if any

v_sim.UiRenderingWindow.props.with_toolbar¶

Name:: with-toolbar
Type:: bool
Default Value:: True
Flags:: WRITABLE, CONSTRUCT_ONLY

if the widget has a toolbar or not