gtk_renderingWindowWidget

gtk_renderingWindowWidget — Defines a complex widget used to render files and print information.

Functions

Properties

gboolean coordinates-in-reduced Read / Write
VisuData * data Read / Write
VisuGlNodeScene * gl-scene Read / Write / Construct Only
VisuGlView * gl-view Read
VisuInteractive * interactive Read
gchar * label Read
VisuNode * selection Read
gboolean with-toolbar Write / Construct Only

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBox
                    ╰── VisuUiRenderingWindow

Implemented Interfaces

VisuUiRenderingWindow implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Description

This is a complex widget, inheriting from GtkWindow, with a rendering area and a status bar area. A VisuData is always attached to this widget, see visu_ui_rendering_window_setData(). If not the V_Sim logo is displayed.

The rendering area can receive keyboard or mouse events, see visu_ui_rendering_window_class_getInteractive.

The status bar area has different buttons to load or export a file. It also display some usefull information like the number of rendered nodes. It has also a real status bar location displaying tips about current available actions. One can add news using visu_ui_rendering_window_pushMessage().

Functions

visu_ui_rendering_window_new ()

GtkWidget *
visu_ui_rendering_window_new (int width,
                              int height,
                              gboolean withFrame,
                              gboolean withToolBar);

A VisuUiRenderingWindow widget is a GtkWindow 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 VisuUiRenderingWindow widget is created.

Parameters

width

its desired width ;

 

height

its desired height ;

 

withFrame

a boolean ;

 

withToolBar

a boolean.

 

Returns

a newly created VisuUiRenderingWindow widget.


visu_ui_rendering_window_new_withGlScene ()

GtkWidget *
visu_ui_rendering_window_new_withGlScene
                               (VisuGlNodeScene *scene,
                                gboolean withToolBar);

visu_ui_rendering_window_pushMessage ()

void
visu_ui_rendering_window_pushMessage (VisuUiRenderingWindow *window,
                                      const gchar *message);

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

Parameters

window

a valid VisuUiRenderingWindow object ;

 

message

an UTF8 string to print on the status bar.

 

visu_ui_rendering_window_popMessage ()

void
visu_ui_rendering_window_popMessage (VisuUiRenderingWindow *window);

Remove the last message.

Parameters

window

a valid VisuUiRenderingWindow object.

 

visu_ui_rendering_window_getGlScene ()

VisuGlNodeScene *
visu_ui_rendering_window_getGlScene (VisuUiRenderingWindow *window);

This method is used to get the VisuGlExtSet attached to the rendering window.

Parameters

window

a valid VisuUiRenderingWindow object.

 

Returns

the VisuGlNodeScene attached to the window or NULL on error.

[transfer none]

Since: 3.8


visu_ui_rendering_window_loadFile ()

void
visu_ui_rendering_window_loadFile (VisuUiRenderingWindow *window,
                                   VisuDataLoadable *data,
                                   guint iSet);

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().

Parameters

window

a valid VisuUiRenderingWindow object.

 

data

the VisuData to be loaded.

[transfer full][allow-none]

iSet

the id of data to load.

 

visu_ui_rendering_window_open ()

void
visu_ui_rendering_window_open (VisuUiRenderingWindow *window,
                               GtkWindow *parent);

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.

Parameters

window

the window the file will by rendered on ;

 

parent

the parent window for the filechooser dialog.

[allow-none]

visu_ui_rendering_window_reload ()

void
visu_ui_rendering_window_reload (VisuUiRenderingWindow *window);

This routines reloads the current VisuData object by rereading it on disk. If there is no current VisuData object, it reports an error.

Parameters

window

a VisuUiRenderingWindow object.

 

Since: 3.7


visu_ui_rendering_window_getAccelGroup ()

GtkAccelGroup *
visu_ui_rendering_window_getAccelGroup
                               (VisuUiRenderingWindow *window);

Retrieve the accelerator group of window .

Parameters

window

a VisuUiRenderingWindow object.

 

Returns

the GtkAccelGroup object of window .

[transfer none]

Since: 3.7


visu_ui_rendering_window_setCurrent ()

void
visu_ui_rendering_window_setCurrent (VisuUiRenderingWindow *window,
                                     gboolean force);

Set the OpenGL area as the current rendering area. If force is TRUE then the context is switched whatever buffered value.

Parameters

window

a valid VisuUiRenderingWindow object ;

 

force

a boolean.

 

Since: 3.5


visu_ui_rendering_window_pushInteractive ()

void
visu_ui_rendering_window_pushInteractive
                               (VisuUiRenderingWindow *window,
                                VisuInteractive *inter);

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

Parameters

window

a VisuUiRenderingWindow object.

 

inter

a VisuInteractive object.

 

Since: 3.6


visu_ui_rendering_window_popInteractive ()

void
visu_ui_rendering_window_popInteractive
                               (VisuUiRenderingWindow *window,
                                VisuInteractive *inter);

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

Parameters

window

a VisuUiRenderingWindow object.

 

inter

a VisuInteractive object.

 

Since: 3.6


visu_ui_rendering_window_setDisplayCoordinatesInReduce ()

gboolean
visu_ui_rendering_window_setDisplayCoordinatesInReduce
                               (VisuUiRenderingWindow *window,
                                gboolean status);

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

Parameters

window

a VisuUiRenderingWindow object.

 

status

a boolean.

 

Returns

TRUE if the value has been changed.

Since: 3.6


visu_ui_rendering_window_getDisplayCoordinatesInReduce ()

gboolean
visu_ui_rendering_window_getDisplayCoordinatesInReduce
                               (const VisuUiRenderingWindow *window);

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.

Parameters

window

a VisuUiRenderingWindow object.

 

Returns

TRUE if the coordinates are displayed in reduced values.

Since: 3.6


visu_ui_rendering_window_class_finalize ()

void
visu_ui_rendering_window_class_finalize
                               (void);

Free memory related to the VisuInteractive object used

[skip]

Since: 3.8

Types and Values

VisuUiRenderingWindow

typedef struct _VisuUiRenderingWindow VisuUiRenderingWindow;

Short form for a VisuUiRenderingWindow_struct structure.


VisuUiRenderingWindowClass

typedef struct _VisuUiRenderingWindowClass VisuUiRenderingWindowClass;

Opaque structure.

Property Details

The “coordinates-in-reduced” property

  “coordinates-in-reduced”   gboolean

display node coordinates in reduced values.

Flags: Read / Write

Default value: FALSE


The “data” property

  “data”                     VisuData *

Data marks are applied to.

Flags: Read / Write


The “gl-scene” property

  “gl-scene”                 VisuGlNodeScene *

GlScene rendered in the window.

Flags: Read / Write / Construct Only


The “gl-view” property

  “gl-view”                  VisuGlView *

GlView mark labels are aligned with.

Flags: Read


The “interactive” property

  “interactive”              VisuInteractive *

current interactive session.

Flags: Read


The “label” property

  “label”                    gchar *

Label representing the data.

Flags: Read

Default value: ""


The “selection” property

  “selection”                VisuNode *

currently selected node, if any.

Flags: Read


The “with-toolbar” property

  “with-toolbar”             gboolean

if the widget has a toolbar or not.

Flags: Write / Construct Only

Default value: TRUE

Signal Details

The “delete-nodes” signal

void
user_function (VisuUiRenderingWindow *visuuirenderingwindow,
               gpointer               user_data)

Flags: No Hooks


The “export” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

Signal emitted when the user ask for data export.

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action

Since: 3.6


The “load-next-file” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

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

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.7


The “load-prev-file” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

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

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.7


The “open” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

Signal emitted when the user ask to open new data.

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action

Since: 3.6


The “reload” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

Signal emitted when the user ask to reload current data.

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action

Since: 3.6


The “search” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

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

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action

Since: 3.7


The “show-action-dialog” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

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

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.6


The “show-main-panel” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

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

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: No Hooks

Since: 3.6


The “show-orientation-chooser” signal

void
user_function (VisuUiRenderingWindow *window,
               gpointer               user_data)

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

Parameters

window

the object emitting the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action

Since: 3.7