vrGUIService

class vrGUIService

(Inherits vrBaseService)

class DialogType

Defines a type of file dialog, e.g. to open/save a texture.

Texture

Dialog for texture files.

MeasuredMaterial

Dialog for measured material files, e.g. X-Rite.

SubstanceArchive

Dialog for Substance archive files.

MDLArchive

Dialog for MDL archive files.

MaterialXArchive

OpenVDB

Dialog for OpenVDB files.

class ViewCubePosition

Defines the position of the view cube.

TopRight

BottomRight

TopLeft

BottomLeft

class ViewCubeSize

Defines the size of the view cube.

Automatic

Adapts to render window size between tiny and normal.

Tiny

Small

Normal

Large

Summary

Functions:

• addMainWindowToolBar(toolbar)
• getFileDialogPath(type) → string
• getViewCubeOpacity() → float
• getViewCubePosition() → vrGUIService.ViewCubePosition
• getViewCubeSize() → vrGUIService.ViewCubeSize
• isNavBarVisible() → bool
• isViewCubeVisible() → bool
• openExportDialog(file, nodes)
• openExportSceneDialog(file)
• openImportDialog(files, parent)
• removeMainWindowToolBar(toolbar)
• setFileDialogPath(type, path)
• setNavBarVisible(value)
• setViewCubeOpacity(value)
• setViewCubePosition(value)
• setViewCubeSize(value)
• setViewCubeVisible(value)
• viewInNewRenderWindow(nodes)

Signals:

• colorThemeChanged(newTheme)
• recentFilesChanged()
• recentFilesCleared()

Functions

vrGUIService.addMainWindowToolBar(toolbar)

Adds a toolbar to the main window and also adds an entry to the Toolbar menu.

Parameters:toolbar (QToolBar) – The toolbar to add

vrGUIService.getFileDialogPath(type)

Returns the path that is used as an initial path for file dialogs for the given type.

Parameters:type (vrGUIService.DialogType) – The type of dialog, e.g. vrGUIService.DialogType.Texture for the file dialog to load/save textures. Returns:Path Return type:string

vrGUIService.getViewCubeOpacity()

Returns:The view cube opacity Return type:float

vrGUIService.getViewCubePosition()

Returns:The view cube position Return type:vrGUIService.ViewCubePosition

vrGUIService.getViewCubeSize()

Returns:The view cube size Return type:vrGUIService.ViewCubeSize

vrGUIService.isNavBarVisible()

Returns:True, if navigation bar is visible Return type:bool

vrGUIService.isViewCubeVisible()

Returns:True, if view cube is visible Return type:bool

vrGUIService.openExportDialog(file, nodes)

Opens the export dialog for the given nodes.

No automatic export is triggered. Modifications to the export settings are still possible.

Parameters:

• file (string) – File path
• nodes (List[vrdNode]) – A list of nodes be exported

vrGUIService.openExportSceneDialog(file)

Opens the export dialog for the scene.

No automatic export is triggered. Modifications to the export settings are still possible.

Parameters:file (string) – File path

vrGUIService.openImportDialog(files, parent=vrdNode())

Opens the import dialog with the given files.

No automatic import is triggered. Modifications to the import settings are still possible.

Parameters:

• files (List[string]) – A list of files to import
• parent (vrdNode) – The parent node in the scene tree where these files should be added

vrGUIService.removeMainWindowToolBar(toolbar)

Removes a toolbar from the main window and also removes the entry from the Toolbar menu.

Parameters:toolbar (QToolBar) – The toolbar to remove

vrGUIService.setFileDialogPath(type, path)

Sets the path that should be used as an initial path for file dialogs for the given type.

In case a full file path is given, e.g. “e:\test\myfile.abc”, the file name will be automatically removed. For network paths forward slashes have to be used, e.g.: “//server/directory/”.

Parameters:

• type (vrGUIService.DialogType) – The type of dialog, e.g. vrGUIService.DialogType.Texture for the file dialog to load/save textures.
• path (string) – The path that should be used as initial value.

vrGUIService.setNavBarVisible(value)

Changes navigation bar visibility.

Parameters:value (bool) – If True, navigation bar is visible

vrGUIService.setViewCubeOpacity(value)

Changes view cubes opacity if mouse is outside the cube area.

Parameters:value (float) – The new opacity

vrGUIService.setViewCubePosition(value)

Changes view cube position.

Parameters:value (ViewCubePosition) – The new position

vrGUIService.setViewCubeSize(value)

Changes view cube size.

Parameters:value (ViewCubeSize) – The new view cube size

vrGUIService.setViewCubeVisible(value)

Changes view cube visibility.

Parameters:value (bool) – If True, view cube is visible

vrGUIService.viewInNewRenderWindow(nodes)

Open a new render window for the given nodes.

Parameters:nodes (List[vrdNode]) – A list of nodes be shown

Signals

vrGUIService.colorThemeChanged(newTheme)

This signal is emitted, when the color theme has changed.

Parameters:newTheme (vrStyleTypes.ColorTheme) –

vrGUIService.recentFilesChanged()

This signal is emitted when the list of recent files is updated.

vrGUIService.recentFilesCleared()

This signal is emitted when the list of recent files is cleared.